Registries

APIs to create, update, list registries

Create Registry.

post

Create a Registry.

Query parameters

space_refstringRequired

Reference to the scope in which the registry exists (required for registry creation).

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/+"}

Body

allowedPatternstring[]Optional

blockedPatternstring[]Optional

descriptionstringOptional

identifierstringRequired

isPublicbooleanRequired

labelsstring[]Optional

opaMetadataValidationbooleanOptional

packageTypestring · enumRequired

refers to package

Possible values:

parentRefstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id
• Organization-level: account_id/org_id
• Project-level: account_id/org_id/project_id

policyRefsstring[]Optional

Responses

201

response for create, get and update registry

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

500

An unexpected server error occurred

application/json

post/v1/registry

POST /api/v1/registry?space_ref=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 507

{
  "allowedPattern": [
    "text"
  ],
  "blockedPattern": [
    "text"
  ],
  "cleanupPolicy": [
    {
      "expireDays": 1,
      "name": "text",
      "packagePrefix": [
        "text"
      ],
      "versionPrefix": [
        "text"
      ]
    }
  ],
  "config": {
    "type": "VIRTUAL",
    "debianConfig": {
      "optionalIndexCompressionFormats": [
        ".xz"
      ],
      "remoteIndexedArchitectures": [
        "text"
      ]
    },
    "upstreamProxies": [
      "text"
    ]
  },
  "description": "text",
  "identifier": "text",
  "isPublic": true,
  "labels": [
    "text"
  ],
  "opaMetadataValidation": true,
  "packageType": "DOCKER",
  "parentRef": "text",
  "policyRefs": [
    "text"
  ],
  "scanners": [
    {
      "name": "AQUA_TRIVY"
    }
  ]
}

{
  "data": {
    "allowedPattern": [
      "text"
    ],
    "blockedPattern": [
      "text"
    ],
    "cleanupPolicy": [
      {
        "expireDays": 1,
        "name": "text",
        "packagePrefix": [
          "text"
        ],
        "versionPrefix": [
          "text"
        ]
      }
    ],
    "config": {
      "type": "VIRTUAL",
      "debianConfig": {
        "optionalIndexCompressionFormats": [
          ".xz"
        ],
        "remoteIndexedArchitectures": [
          "text"
        ]
      },
      "upstreamProxies": [
        "text"
      ]
    },
    "createdAt": "text",
    "deletedAt": "text",
    "description": "text",
    "identifier": "text",
    "isPublic": true,
    "labels": [
      "text"
    ],
    "modifiedAt": "text",
    "opaMetadataValidation": true,
    "packageType": "DOCKER",
    "policyRefs": [
      "text"
    ],
    "scanners": [
      {
        "name": "AQUA_TRIVY"
      }
    ],
    "url": "text",
    "uuid": "text"
  },
  "status": "SUCCESS"
}

Returns Registry Details

get

Returns Registry Details in the account for the given key

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

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/registry123/+"}

Responses

200

response for create, get and update registry

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}

GET /api/v1/registry/{registry_ref} HTTP/1.1
Accept: */*

{
  "data": {
    "allowedPattern": [
      "text"
    ],
    "blockedPattern": [
      "text"
    ],
    "cleanupPolicy": [
      {
        "expireDays": 1,
        "name": "text",
        "packagePrefix": [
          "text"
        ],
        "versionPrefix": [
          "text"
        ]
      }
    ],
    "config": {
      "type": "VIRTUAL",
      "debianConfig": {
        "optionalIndexCompressionFormats": [
          ".xz"
        ],
        "remoteIndexedArchitectures": [
          "text"
        ]
      },
      "upstreamProxies": [
        "text"
      ]
    },
    "createdAt": "text",
    "deletedAt": "text",
    "description": "text",
    "identifier": "text",
    "isPublic": true,
    "labels": [
      "text"
    ],
    "modifiedAt": "text",
    "opaMetadataValidation": true,
    "packageType": "DOCKER",
    "policyRefs": [
      "text"
    ],
    "scanners": [
      {
        "name": "AQUA_TRIVY"
      }
    ],
    "url": "text",
    "uuid": "text"
  },
  "status": "SUCCESS"
}

Updates a Registry

put

Updates a Registry in the account for the given key

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

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/registry123/+"}

Body

allowedPatternstring[]Optional

blockedPatternstring[]Optional

descriptionstringOptional

identifierstringRequired

isPublicbooleanRequired

labelsstring[]Optional

opaMetadataValidationbooleanOptional

packageTypestring · enumRequired

refers to package

Possible values:

parentRefstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id
• Organization-level: account_id/org_id
• Project-level: account_id/org_id/project_id

policyRefsstring[]Optional

Responses

200

response for create, get and update registry

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

put/v1/registry/{registry_ref}

PUT /api/v1/registry/{registry_ref} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 507

{
  "allowedPattern": [
    "text"
  ],
  "blockedPattern": [
    "text"
  ],
  "cleanupPolicy": [
    {
      "expireDays": 1,
      "name": "text",
      "packagePrefix": [
        "text"
      ],
      "versionPrefix": [
        "text"
      ]
    }
  ],
  "config": {
    "type": "VIRTUAL",
    "debianConfig": {
      "optionalIndexCompressionFormats": [
        ".xz"
      ],
      "remoteIndexedArchitectures": [
        "text"
      ]
    },
    "upstreamProxies": [
      "text"
    ]
  },
  "description": "text",
  "identifier": "text",
  "isPublic": true,
  "labels": [
    "text"
  ],
  "opaMetadataValidation": true,
  "packageType": "DOCKER",
  "parentRef": "text",
  "policyRefs": [
    "text"
  ],
  "scanners": [
    {
      "name": "AQUA_TRIVY"
    }
  ]
}

{
  "data": {
    "allowedPattern": [
      "text"
    ],
    "blockedPattern": [
      "text"
    ],
    "cleanupPolicy": [
      {
        "expireDays": 1,
        "name": "text",
        "packagePrefix": [
          "text"
        ],
        "versionPrefix": [
          "text"
        ]
      }
    ],
    "config": {
      "type": "VIRTUAL",
      "debianConfig": {
        "optionalIndexCompressionFormats": [
          ".xz"
        ],
        "remoteIndexedArchitectures": [
          "text"
        ]
      },
      "upstreamProxies": [
        "text"
      ]
    },
    "createdAt": "text",
    "deletedAt": "text",
    "description": "text",
    "identifier": "text",
    "isPublic": true,
    "labels": [
      "text"
    ],
    "modifiedAt": "text",
    "opaMetadataValidation": true,
    "packageType": "DOCKER",
    "policyRefs": [
      "text"
    ],
    "scanners": [
      {
        "name": "AQUA_TRIVY"
      }
    ],
    "url": "text",
    "uuid": "text"
  },
  "status": "SUCCESS"
}

Delete a Registry

delete

Delete a Registry in the account for the given key

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

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/registry123/+"}

Responses

200

Generic success response

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

delete/v1/registry/{registry_ref}

DELETE /api/v1/registry/{registry_ref} HTTP/1.1
Accept: */*

{
  "status": "SUCCESS"
}

List Artifacts for Registry

get

Lists all the Artifacts for Registry

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

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/registry123/+"}

Query parameters

labelstring[]Optional

Label.

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.

artifact_typestring · enumOptional

artifact type.

Possible values:

Responses

200

response for list artifact

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/artifacts

GET /api/v1/registry/{registry_ref}/artifacts HTTP/1.1
Accept: */*

{
  "data": {
    "artifacts": [
      {
        "artifactType": "model",
        "deletedAt": "text",
        "downloadsCount": 1,
        "isPublic": true,
        "isQuarantined": true,
        "labels": [
          "text"
        ],
        "lastModified": "text",
        "latestVersion": "text",
        "name": "text",
        "packageType": "DOCKER",
        "registryIdentifier": "text",
        "registryPath": "text",
        "registryUUID": "text",
        "uuid": "text"
      }
    ],
    "itemCount": 1,
    "pageCount": 100,
    "pageIndex": 0,
    "pageSize": 1
  },
  "status": "SUCCESS"
}

Returns CLI Client Setup Details

get

Returns CLI Client Setup Details based on package type

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

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/registry123/+"}

Query parameters

artifactstringOptional

Artifat

versionstringOptional

Version

artifact_typestring · enumOptional

artifact type.

Possible values:

Responses

200

response for client setup details

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/client-setup-details

GET /api/v1/registry/{registry_ref}/client-setup-details HTTP/1.1
Accept: */*

{
  "data": {
    "mainHeader": "text",
    "secHeader": "text",
    "sections": [
      {
        "steps": [
          {
            "commands": [
              {
                "label": "text",
                "value": "text"
              }
            ],
            "header": "text",
            "type": "Static"
          }
        ]
      }
    ]
  },
  "status": "SUCCESS"
}