Components
Set a version's status
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*component_id
The component_id path parameter.
Match
^cmp-[0-9a-z]+$digest*digest
sha256:<hex>. A digest, not a tag: the status belongs to the bytes, and
a floating tag might name different bytes by the time anyone reads the
reason.
Match
^sha256:[0-9a-f]{64}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
SetVersionStatusRequest names a version by digest, its new status, and why.
Response Body
application/json
curl -X POST "https://example.com/v1/components/string/versions/string/set-status" \ -H "Content-Type: application/json" \ -d '{ "status": "STATUS_UNSPECIFIED", "reason": "string" }'{ "version": { "id": "string", "component_id": "string", "digest": "string", "kind": "COMPONENT_KIND_UNSPECIFIED", "size_bytes": "string", "contract": { "inputs": [ { "name": "string", "type": "string", "description": "string", "required": true, "default": null, "sensitive": true, "ephemeral": true, "nullable": true, "deprecated": "string", "validations": [ { "condition": "string", "error_message": "string" } ], "schema": { "property1": null, "property2": null } } ], "outputs": [ { "name": "string", "description": "string", "sensitive": true } ] }, "provenance": { "kind": "KIND_UNSPECIFIED", "uri": "string", "ref": "string", "commit": "string", "path": "string", "dependencies": [ { "source": "string", "constraint": "string", "resolved": "string" } ], "credentials": [ { "id": "string", "name": "string", "hosts": [ "string" ] } ], "commit_message": "string", "commit_author": "string" }, "findings": [ { "severity": "FINDING_SEVERITY_UNSPECIFIED", "source": "string", "code": "string", "message": "string", "path": "string" } ], "status": "STATUS_UNSPECIFIED", "status_changed_at": "2023-01-15T01:30:15.01Z", "status_reason": "string", "tags": [ "string" ], "created_by": { "id": "string", "display_name": "string", "email": "string" }, "created_at": "2023-01-15T01:30:15.01Z", "providers": [ "string" ], "baseline_values_json": "string" }}