Components
Update a component
Scope: component:write
Authorization
bearerAuth AuthorizationBearer <token>
An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...
In: header
Path Parameters
component.id*id
Unique identifier.
Match
^cmp-[0-9a-z]+$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
UpdateComponentRequest carries the fields to change. Omitted fields are left as they are.
Response Body
application/json
curl -X PATCH "https://example.com/v1/components/string" \ -H "Content-Type: application/json" \ -d '{}'{ "component": { "id": "string", "name": "string", "description": "string", "labels": { "property1": "string", "property2": "string" }, "tags": [ { "name": "string", "digest": "string", "immutable": true, "created_at": "2023-01-15T01:30:15.01Z", "updated_at": "2023-01-15T01:30:15.01Z" } ], "created_by": { "id": "string", "display_name": "string", "email": "string" }, "created_at": "2023-01-15T01:30:15.01Z", "updated_at": "2023-01-15T01:30:15.01Z", "status": "STATUS_UNSPECIFIED", "status_reason": "string", "status_changed_at": "2023-01-15T01:30:15.01Z", "successor_component_id": "string" }}