Code
api/compliance/code
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/compliance/code Changed · +55 / -131 lines
## Code › Artifacts ### List Code Artifacts #### Query parameters #### Headers #### Returns #### Example ##### Response (200) ### Download Code Artifact Version Content #### Path parameters #### Headers #### Example ### Delete Code Artifact #### Path parameters #### Headers #### Returns #### Example ##### Response (200) # Artifacts ## List Code Artifacts ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Download Code Artifact Version Content ### Path Parameters ### Header Parameters ### Example ## Delete Code Artifact ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Artifact List Response ### Artifact Delete Response
---- -title: Code -url: https://platform.claude.com/docs/en/api/compliance/code ---- - # Code -# Artifacts +## Code › Artifacts -## List Code Artifacts +### List Code Artifacts -**get** `/v1/compliance/apps/code/artifacts` +**GET** `/v1/compliance/apps/code/artifacts` List Claude Code Artifacts owned by organizations under the parent organization.
Artifacts owned by a since-deleted child organization are not returned. -### Query Parameters +#### Query parameters - `limit: optional number` Maximum results (default: 20, max: 100) + default: 20, maximum: 100, minimum: 1 + - `organization_ids: optional array of string` Filter by organization IDs (accepts `org_...` or organization UUID, up to 500). Enumerate IDs via `GET /v1/compliance/organizations`. + maxItems: 500 + - `page: optional string` Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice. -- `updated_at: optional object { gt, gte, lt, lte }` +- `updated_at: optional object` - `gt: optional string` Return only Artifacts updated after this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat. + format: date-time + - `gte: optional string` Return only Artifacts updated at or after this time (RFC 3339 format). Time filters match an eventually-consistent index and Artifacts published before this field was recorded never match — omit the time filter for compliance-complete enumeration. For incremental export, apply a generous overlap margin between windows and dedupe by `id`: adjacent tiling silently misses items whose index update lagged their publish. + format: date-time + - `lt: optional string` Return only Artifacts updated before this time (RFC 3339 format). Multiple time operators are AND-ed to the tightest bound. See `updated_at.gte` for the completeness caveat. + format: date-time + - `lte: optional string` Return only Artifacts updated at or before this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat. + format: date-time + - `user_ids: optional array of string` Filter by owner user IDs (up to 200). Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`. -### Header Parameters + maxItems: 200 +#### Headers + - `"x-api-key": optional string` -### Returns +#### Returns -- `data: array of object { id, organization_uuid, owner_user_id, 5 more }` +- `data: array of object` Page of Artifacts
Artifact last update timestamp, or null for Artifacts published before this field was recorded - - `user: object { id, email_address } or null` + format: date-time + - `user: object or null` + The user who owns a Code Artifact. Fields that reference this type are null when the Artifact was
User's email address - - `versions: array of object { id, created_at, name }` + - `versions: array of object` Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content.
When this version was published + format: date-time + - `name: string` Artifact title at this version. Falls back to the version identifier when the title for an older version is no longer retained.
Token to retrieve the next page. Use this as the 'page' parameter in your next request -### Example +#### Example -```http +```bash curl https://api.anthropic.com/v1/compliance/apps/code/artifacts \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` -#### Response +##### Response (200) ```json {
} ``` -## Download Code Artifact Version Content +### Download Code Artifact Version Content -**get** `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` +**GET** `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` Streams the content of one version of a Claude Code Artifact as the response body.
only truncation signal for encoded content. `Content-MD5` is emitted only for identity-stored content; validate against it when present. -### Path Parameters +#### Path parameters - `artifact_id: string`
Opaque version identifier from the Artifact's `versions` list -### Header Parameters +#### Headers - `"x-api-key": optional string` -### Example +#### Example -```http +```bash curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID/versions/$VERSION_ID \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` -## Delete Code Artifact +### Delete Code Artifact -**delete** `/v1/compliance/apps/code/artifacts/{artifact_id}` +**DELETE** `/v1/compliance/apps/code/artifacts/{artifact_id}` Permanently deletes a Code Artifact and all its versions. This is a destructive operation that cannot be undone. A 200 response means the
organization. Returns 404 on a repeated delete of an already-deleted Artifact. -### Path Parameters +#### Path parameters - `artifact_id: string` The Artifact ID (tagged ID, e.g., cart_abc123) -### Header Parameters +#### Headers - `"x-api-key": optional string` -### Returns +#### Returns - `id: string`
Constant string confirming deletion - - `"code_artifact_deleted"` + default: code_artifact_deleted -### Example +#### Example -```http +```bash curl https://api.anthropic.com/v1/compliance/apps/code/artifacts/$ARTIFACT_ID \ -X DELETE \ -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY" ``` -#### Response +##### Response (200) ```json {
"type": "code_artifact_deleted" } ``` - -## Domain Types - -### Artifact List Response - -- `ArtifactListResponse object { id, organization_uuid, owner_user_id, 5 more }` - - A hosted site published via Claude Code. - - - `id: string` - - Artifact identifier (tagged ID) - - - `organization_uuid: string` - - Organization UUID this Artifact belongs to - - - `owner_user_id: string or null` - - Artifact owner's user identifier (tagged ID), or null for Artifacts published by an agent session rather than a user account. When set, it survives after the owner's account is deleted or the owner leaves every organization under the parent. - - - `published_version_id: string or null` - - Identifier of the version a non-owner viewer would render when `read_mode` permits them — the version the owner has pinned for non-owner readers if one is pinned, otherwise the owner's latest. When `read_mode` is `owner` no non-owner renders any version; the field still reports which version would be served were read_mode widened. - - - `read_mode: "org" or "owner" or "public" or "users"` - - Who can view this Artifact: only its owner, a named set of users, every member of its organization, or anyone on the internet (`public`) - - - `"org"` - - - `"owner"` - - - `"public"` - - - `"users"` - - - `updated_at: string or null` - - Artifact last update timestamp, or null for Artifacts published before this field was recorded - - - `user: object { id, email_address } or null` - - The user who owns a Code Artifact. - - Fields that reference this type are null when the Artifact was - published by an agent session rather than a user account, when the - owner's account has been deleted, or when the owner is no longer a - member of an organization the key may read. - - - `id: string` - - User identifier (tagged ID) - - - `email_address: string` - - User's email address - - - `versions: array of object { id, created_at, name }` - - Up to roughly 20 most-recently-published versions of this Artifact (older versions are not retained). Metadata only — use `GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}` to download a version's content. - - - `id: string` - - Opaque version identifier - - - `created_at: string or null` - - When this version was published - - - `name: string` - - Artifact title at this version. Falls back to the version identifier when the title for an older version is no longer retained. - -### Artifact Delete Response - -- `ArtifactDeleteResponse object { id, type }` - - Response for deleting a Code Artifact. - - - `id: string` - - The ID of the Artifact that was deleted - - - `type: "code_artifact_deleted"` - - Constant string confirming deletion - - - `"code_artifact_deleted"`