Get container registry artifact details

GET 
/container_registry/artifacts/artifact

Returns full details for a given container registry artifact

Scopes

• container_registry
• container_registry:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

region[id] string

The region in which the artifact to be returned exists.

repository[id] string

The repository in which the artifact to be returned exists.

All 'repository[]' params are mutually exclusive, only one can be provided.

repository[name] string

The repository in which the artifact to be returned exists.

All 'repository[]' params are mutually exclusive, only one can be provided.

artifact[id] string

The artifact to be returned.

All 'artifact[]' params are mutually exclusive, only one can be provided.

artifact[digest] string

The artifact to be returned.

All 'artifact[]' params are mutually exclusive, only one can be provided.

artifact[tag] string

The artifact to be returned.

All 'artifact[]' params are mutually exclusive, only one can be provided.

Responses

200

Returns full details for a given container registry artifact

application/json

Schema

Schema

artifact

object

required

id string

digest string

size integernullable

Size of the artifact in bytes

media_type stringnullable

os stringnullable

architecture stringnullable

variant stringnullable

annotations

object[]

Array [

key stringrequired

value string

]

last_pushed_at integernullable

last_pulled_at integernullable

last_reconciled_at integernullable

tags string[]

child_ids string[]

blobs

object[]

required

The blobs for the artifact

Array [

digest string

size integer

Size of the blob in bytes

media_type string

]

tags

object[]

required

The tags for the artifact

Array [

name string

last_pushed_at integernullable

last_pulled_at integernullable

]

Example (from schema)

{
  "artifact": {
    "id": "string",
    "digest": "string",
    "size": 0,
    "media_type": "string",
    "os": "string",
    "architecture": "string",
    "variant": "string",
    "annotations": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "last_pushed_at": 0,
    "last_pulled_at": 0,
    "last_reconciled_at": 0,
    "tags": [
      "string"
    ],
    "child_ids": [
      "string"
    ]
  },
  "blobs": [
    {
      "digest": "string",
      "size": 0,
      "media_type": "string"
    }
  ],
  "tags": [
    {
      "name": "string",
      "last_pushed_at": 0,
      "last_pulled_at": 0
    }
  ]
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

PermissionDeniedSchema

The authenticated identity is not permitted to perform this action

code PermissionDeniedEnum (string)

Possible values: [permission_denied]

description string

detail

object

details stringnullable

Additional information regarding the reason why permission was denied

Example (from schema)

{}

404

404 error response

application/json

Schema

Schema

oneOf

ContainerRegistryRegionNotFoundSchema

No container registry region was found matching any of the criteria provided in the arguments

code ContainerRegistryRegionNotFoundEnum (string)

Possible values: [container_registry_region_not_found]

description string

detail object

RepositoryNotFoundSchema

No container registry repository was found matching any of the criteria provided in the arguments.

code RepositoryNotFoundEnum (string)

Possible values: [repository_not_found]

description string

detail object

ArtifactNotFoundSchema

No container registry artifact was found matching any of the criteria provided in the arguments.

code ArtifactNotFoundEnum (string)

Possible values: [artifact_not_found]

description string

detail object

Example (from schema)

{}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...