Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Spaces

Get artifact stats

get

Get artifact stats

Path parameters
space_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

  • Account-level: account_id/+
  • Organization-level: account_id/org/+
  • Project-level: account_id/org/project/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/+"}
Query parameters
fromstringOptional

Date. Format - MM/DD/YYYY

tostringOptional

Date. Format - MM/DD/YYYY

Responses
200

response to get artifact stats response

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/spaces/{space_ref}/artifact/stats
GET /api/v1/spaces/{space_ref}/artifact/stats HTTP/1.1
Accept: */*
{
  "data": {
    "downloadCount": 1,
    "downloadSize": 1,
    "totalStorageSize": 1,
    "uploadSize": 1
  },
  "status": "SUCCESS"
}

List artifacts

get

Lists all the artifacts

Path parameters
space_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

  • Account-level: account_id/+
  • Organization-level: account_id/org/+
  • Project-level: account_id/org/project/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/+"}
Query parameters
reg_identifierstring[]Optional

Registry Identifier

pageinteger · int64Optional

Current page number

Default: 1
sizeinteger · int64Optional

Number of items per page

Default: 20
sort_orderstringOptional

sortOrder

sort_fieldstringOptional

sortField

search_termstringOptional

search Term.

latest_versionbooleanOptional

Latest Version Filter.

deployed_artifactbooleanOptional

Deployed Artifact Filter.

package_typestring[]Optional

Registry Package Type

Responses
200

response for list artifact

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/spaces/{space_ref}/artifacts
GET /api/v1/spaces/{space_ref}/artifacts HTTP/1.1
Accept: */*
{
  "data": {
    "artifacts": [
      {
        "artifactKey": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "artifactType": "model",
        "deletedAt": "text",
        "deploymentMetadata": {
          "nonProdEnvCount": 1,
          "prodEnvCount": 1
        },
        "digestCount": 1,
        "downloadsCount": 1,
        "fileCount": 1,
        "firewallMode": "ENABLED",
        "isQuarantined": true,
        "labels": [
          "text"
        ],
        "lastModified": "text",
        "lastScannedAt": "text",
        "latestVersion": "text",
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "name": "text",
        "packageType": "DOCKER",
        "pullCommand": "text",
        "purl": "text",
        "quarantineReason": "text",
        "registryIdentifier": "text",
        "registryPath": "text",
        "registryType": "VIRTUAL",
        "registryUUID": "text",
        "scanId": "text",
        "scanStatus": "WARN",
        "uuid": "text",
        "version": "text"
      }
    ],
    "itemCount": 1,
    "pageCount": 100,
    "pageIndex": 0,
    "pageSize": 1
  },
  "status": "SUCCESS"
}

Get storage details for given space

get

Get storage details for given space

Path parameters
space_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

  • Account-level: account_id/+
  • Organization-level: account_id/org/+
  • Project-level: account_id/org/project/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/+"}
Responses
200

response for storage details

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/spaces/{space_ref}/details
GET /api/v1/spaces/{space_ref}/details HTTP/1.1
Accept: */*
{
  "data": {
    "dailyStorage": [
      {
        "date": "2026-01-01",
        "size": "text"
      }
    ],
    "last30DayAverage": "text",
    "totalSize": "text",
    "totalSizeInBytes": "text"
  },
  "status": "SUCCESS"
}
get
Path parameters
space_refstringRequired
Query parameters
pageinteger · min: 1Optional

The page to return.

Default: 1
limitinteger · min: 1 · max: 100Optional

The maximum number of results to return.

Default: 30
inheritedbooleanOptional

The result should inherit entities from parent spaces.

Default: false
querystringOptional

The substring which is used to filter the labels by their key.

Responses
200

OK

application/json
colorstring · enumOptionalPossible values:
createdinteger · int64Optional
created_byinteger · int64Optional
descriptionstringOptional
idinteger · int64Optional
keystringOptional
scopeinteger · int64Optional
space_idinteger · int64 · nullableOptional
typestring · enumOptionalPossible values:
updatedinteger · int64Optional
updated_byinteger · int64Optional
value_countinteger · int64Optional
get/v1/spaces/{space_ref}/labels
GET /api/v1/spaces/{space_ref}/labels HTTP/1.1
Accept: */*
[
  {
    "color": "blue",
    "created": 1,
    "created_by": 1,
    "description": "text",
    "id": 1,
    "key": "text",
    "scope": 1,
    "space_id": 1,
    "type": "dynamic",
    "updated": 1,
    "updated_by": 1,
    "value_count": 1
  }
]
post
Path parameters
space_refstringRequired
Body
colorstring · enumOptionalPossible values:
descriptionstringOptional
keystringOptional
typestring · enumOptionalPossible values:
Responses
201

Created

application/json
colorstring · enumOptionalPossible values:
createdinteger · int64Optional
created_byinteger · int64Optional
descriptionstringOptional
idinteger · int64Optional
keystringOptional
scopeinteger · int64Optional
space_idinteger · int64 · nullableOptional
typestring · enumOptionalPossible values:
updatedinteger · int64Optional
updated_byinteger · int64Optional
value_countinteger · int64Optional
post/v1/spaces/{space_ref}/labels
POST /api/v1/spaces/{space_ref}/labels HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "color": "blue",
  "description": "text",
  "key": "text",
  "type": "dynamic"
}
{
  "color": "blue",
  "created": 1,
  "created_by": 1,
  "description": "text",
  "id": 1,
  "key": "text",
  "scope": 1,
  "space_id": 1,
  "type": "dynamic",
  "updated": 1,
  "updated_by": 1,
  "value_count": 1
}
put
Path parameters
space_refstringRequired
Body
Responses
200

OK

application/json
put/v1/spaces/{space_ref}/labels
PUT /api/v1/spaces/{space_ref}/labels HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "label": {
    "color": "blue",
    "description": "text",
    "id": 1,
    "key": "text",
    "type": "dynamic"
  },
  "values": [
    {
      "color": "blue",
      "id": 1,
      "value": "text"
    }
  ]
}
{
  "label": {
    "color": "blue",
    "created": 1,
    "created_by": 1,
    "description": "text",
    "id": 1,
    "key": "text",
    "scope": 1,
    "space_id": 1,
    "type": "dynamic",
    "updated": 1,
    "updated_by": 1,
    "value_count": 1
  },
  "values": [
    {
      "color": "blue",
      "created": 1,
      "created_by": 1,
      "id": 1,
      "label_id": 1,
      "updated": 1,
      "updated_by": 1,
      "value": "text"
    }
  ]
}
get
Path parameters
space_refstringRequired
keystringRequired
Query parameters
include_valuesbooleanOptional

The result should include label values.

Default: false
Responses
201

Created

application/json
get/v1/spaces/{space_ref}/labels/{key}
GET /api/v1/spaces/{space_ref}/labels/{key} HTTP/1.1
Accept: */*
{
  "label": {
    "color": "blue",
    "created": 1,
    "created_by": 1,
    "description": "text",
    "id": 1,
    "key": "text",
    "scope": 1,
    "space_id": 1,
    "type": "dynamic",
    "updated": 1,
    "updated_by": 1,
    "value_count": 1
  },
  "values": [
    {
      "color": "blue",
      "created": 1,
      "created_by": 1,
      "id": 1,
      "label_id": 1,
      "updated": 1,
      "updated_by": 1,
      "value": "text"
    }
  ]
}
delete
Path parameters
space_refstringRequired
keystringRequired
Responses
204

No Content

No content

delete/v1/spaces/{space_ref}/labels/{key}
DELETE /api/v1/spaces/{space_ref}/labels/{key} HTTP/1.1
Accept: */*

No content

patch
Path parameters
space_refstringRequired
keystringRequired
Body
colorstring · enumOptionalPossible values:
descriptionstringOptional
keystringOptional
typestring · enumOptionalPossible values:
Responses
200

OK

application/json
colorstring · enumOptionalPossible values:
createdinteger · int64Optional
created_byinteger · int64Optional
descriptionstringOptional
idinteger · int64Optional
keystringOptional
scopeinteger · int64Optional
space_idinteger · int64 · nullableOptional
typestring · enumOptionalPossible values:
updatedinteger · int64Optional
updated_byinteger · int64Optional
value_countinteger · int64Optional
patch/v1/spaces/{space_ref}/labels/{key}
PATCH /api/v1/spaces/{space_ref}/labels/{key} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "color": "blue",
  "description": "text",
  "key": "text",
  "type": "dynamic"
}
{
  "color": "blue",
  "created": 1,
  "created_by": 1,
  "description": "text",
  "id": 1,
  "key": "text",
  "scope": 1,
  "space_id": 1,
  "type": "dynamic",
  "updated": 1,
  "updated_by": 1,
  "value_count": 1
}
get
Path parameters
space_refstringRequired
keystringRequired
Responses
200

OK

application/json
colorstring · enumOptionalPossible values:
createdintegerOptional
created_byintegerOptional
idintegerOptional
label_idintegerOptional
updatedintegerOptional
updated_byintegerOptional
valuestringOptional
get/v1/spaces/{space_ref}/labels/{key}/values
GET /api/v1/spaces/{space_ref}/labels/{key}/values HTTP/1.1
Accept: */*
[
  {
    "color": "blue",
    "created": 1,
    "created_by": 1,
    "id": 1,
    "label_id": 1,
    "updated": 1,
    "updated_by": 1,
    "value": "text"
  }
]
post
Path parameters
space_refstringRequired
keystringRequired
Body
colorstring · enumOptionalPossible values:
valuestringOptional
Responses
201

Created

application/json
colorstring · enumOptionalPossible values:
createdintegerOptional
created_byintegerOptional
idintegerOptional
label_idintegerOptional
updatedintegerOptional
updated_byintegerOptional
valuestringOptional
post/v1/spaces/{space_ref}/labels/{key}/values
POST /api/v1/spaces/{space_ref}/labels/{key}/values HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "color": "blue",
  "value": "text"
}
{
  "color": "blue",
  "created": 1,
  "created_by": 1,
  "id": 1,
  "label_id": 1,
  "updated": 1,
  "updated_by": 1,
  "value": "text"
}
delete
Path parameters
space_refstringRequired
keystringRequired
valuestringRequired
Responses
204

No Content

No content

delete/v1/spaces/{space_ref}/labels/{key}/values/{value}
DELETE /api/v1/spaces/{space_ref}/labels/{key}/values/{value} HTTP/1.1
Accept: */*

No content

patch
Path parameters
space_refstringRequired
keystringRequired
valuestringRequired
Body
colorstring · enumOptionalPossible values:
valuestringOptional
Responses
200

OK

application/json
colorstring · enumOptionalPossible values:
createdintegerOptional
created_byintegerOptional
idintegerOptional
label_idintegerOptional
updatedintegerOptional
updated_byintegerOptional
valuestringOptional
patch/v1/spaces/{space_ref}/labels/{key}/values/{value}
PATCH /api/v1/spaces/{space_ref}/labels/{key}/values/{value} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "color": "blue",
  "value": "text"
}
{
  "color": "blue",
  "created": 1,
  "created_by": 1,
  "id": 1,
  "label_id": 1,
  "updated": 1,
  "updated_by": 1,
  "value": "text"
}

List registries

get

Lists all the registries.

Path parameters
space_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

  • Account-level: account_id/+
  • Organization-level: account_id/org/+
  • Project-level: account_id/org/project/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/+"}
Query parameters
package_typestring[]Optional

Registry Package Type

typestring · enumOptional

Registry Type

Possible values:
pageinteger · int64Optional

Current page number

Default: 1
sizeinteger · int64Optional

Number of items per page

Default: 20
sort_orderstringOptional

sortOrder

sort_fieldstringOptional

sortField

search_termstringOptional

search Term.

recursivebooleanOptional

Whether to list registries recursively.

Deprecated. Use the new scope parameter.

  • recursive=true → scope=ancestors
  • recursive=false → scope=none
Default: false
scopestring · enumOptional

Scope of registries to list

  • none – current space only (default) * ancestors – current space plus all parent spaces * descendants – current space plus all child spaces
    If omitted, none is assumed.
Possible values:
Responses
200

response for list registry

application/json
statusstring · enumRequired

Request processing status indicator

Possible values:
get/v1/spaces/{space_ref}/registries
GET /api/v1/spaces/{space_ref}/registries HTTP/1.1
Accept: */*
{
  "data": {
    "itemCount": 1,
    "meta": {
      "activeCount": 95,
      "deletedCount": 5
    },
    "pageCount": 100,
    "pageIndex": 0,
    "pageSize": 1,
    "registries": [
      {
        "artifactsCount": 1,
        "deletedAt": "text",
        "deletedBy": {
          "email": "text",
          "name": "text"
        },
        "description": "text",
        "downloadsCount": 1,
        "identifier": "text",
        "isPublic": true,
        "lastModified": "text",
        "packageType": "DOCKER",
        "path": "text",
        "registrySize": "text",
        "type": "VIRTUAL",
        "url": "text",
        "uuid": "text"
      }
    ]
  },
  "status": "SUCCESS"
}

Last updated

Was this helpful?