Update a resource
PATCH /resources/{resource_id}
Updates the specified resource with partial information.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
resource_id |
string |
path |
True |
ID of the resource.
|
Request Body
Replaces the specified attributes in the request body with the values provided.
Name | Type | Required | Description |
---|---|---|---|
description |
string |
False |
JSON string containing the description of the resource. Defined values are:
|
id |
string |
False |
Globally unique identifier of the resource. Defined values are:
|
isSystem |
string |
False |
Specifies if an object is system generated. Defined values are:
|
legacyId |
string |
False |
Unique identifier as understood by the previous version of this service. |
metadata |
False |
Metadata associated with the resource. |
|
name |
string |
False |
JSON string containing a name for the resource. Defined values are:
|
ownerOrganizationId |
string |
False |
JSON string containing the ID of the organization. |
parentId |
string |
False |
JSON string containing the ID of the hierarchy. |
rawId |
string |
False |
JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control.
|
resourceClass |
string |
False |
JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. |
resourceType |
string |
False |
JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the BlueXP IAM system. |
state |
string |
False |
Represents the state of the resource. State of the resource can be reconciling, which indicates the resource is currently undergoing a reconciliation process or available, which indicates the resources is currently available. Defined values are:
|
tags |
array[tags] |
False |
JSON array of tags (name/value pairs) representing metadata for the resource. |
type |
string |
True |
Media type of the resource. Defined values are:
|
version |
string |
True |
Version of the resource. Defined values are:
|
Example request
Response
Status: 204, Indicates if the resource was updated.
Error
Status: 400, Bad request
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or trace ID related. |
detail |
string |
False |
Details about the problem. |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters. |
status |
string |
True |
HTTP error code related to the problem. |
title |
string |
True |
Title description of the problem. |
type |
string |
True |
Content-type of the object. |
Example error response
Error
Status: 401, Unauthorized
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or trace ID related. |
detail |
string |
False |
Details about the problem. |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters. |
status |
string |
True |
HTTP error code related to the problem. |
title |
string |
True |
Title description of the problem. |
type |
string |
True |
Content-type of the object. |
Example error response
Error
Status: 403, Forbidden
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or trace ID related. |
detail |
string |
False |
Details about the problem. |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters. |
status |
string |
True |
HTTP error code related to the problem. |
title |
string |
True |
Title description of the problem. |
type |
string |
True |
Content-type of the object. |
Example error response
Error
Status: 404, Not found
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or trace ID related. |
detail |
string |
False |
Details about the problem. |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters. |
status |
string |
True |
HTTP error code related to the problem. |
title |
string |
True |
Title description of the problem. |
type |
string |
True |
Content-type of the object. |
Example error response
Error
Status: 409, Conflict
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or trace ID related. |
detail |
string |
False |
Details about the problem. |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters. |
status |
string |
True |
HTTP error code related to the problem. |
title |
string |
True |
Title description of the problem. |
type |
string |
True |
Content-type of the object. |
Example error response
Definitions
See Definitions
type_bxp_label
Name/value pair.
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
|
value |
string |
True |
type_bxp_metadata
Metadata associated with the resource.
Name | Type | Required | Description |
---|---|---|---|
createdBy |
string |
False |
UUID of the user who created the resource. |
creationTimestamp |
string |
False |
Resource creation date. |
labels |
array[type_bxp_label] |
False |
Array of name/value pairs representing additional information for the resource. |
modificationTimestamp |
string |
False |
Resource modification date. |
modifiedBy |
string |
False |
UUID of the user who modified the resource. |
invalidParams
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
Name of the invalid parameter. |
reason |
string |
True |
Reason why the parameter is invalid. |