Sign Up

Docker Registry

List registries

GET
/docker-registry

Authorization

headerAuthorizationBearer <token>

API Key access

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

List of all docker registries

application/json
  1. response
[index: integer]?
curl -X GET 'http://localhost:3000/docker-registry'
[  {    "mtlsSecretArn": "mtlsSecretArn",    "registryType": "internal",    "createdAt": "2024-01-31T12:00:00Z",    "name": "My Docker Hub",    "project": "my-project",    "id": "123e4567-e89b-12d3-a456-426614174000",    "url": "https://registry.hub.docker.com",    "mtlsRoleArn": "mtlsRoleArn",    "username": "username",    "updatedAt": "2024-01-31T12:00:00Z"  }]

Create registry

POST
/docker-registry

Authorization

headerAuthorizationBearer <token>

API Key access

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Request Body

application/json
  1. body
mtlsRoleArn?|

IAM role ARN for registry mTLS; supply with mtlsSecretArn, or set both to null to clear

mtlsSecretArn?|

Secrets Manager ARN for registry mTLS; supply with mtlsRoleArn, or set both to null to clear

name*string

Registry name

url*string

Registry URL

username*string

Registry username

password*string

Registry password

project?string

Registry project

Response Body

The docker registry has been successfully created.

application/json
  1. response
id*string

Registry ID

name*string

Registry name

url*string

Registry URL

username*string

Registry username

mtlsRoleArn*|

IAM role ARN for registry mTLS

mtlsSecretArn*|

Secrets Manager ARN for registry mTLS

project*string

Registry project

registryType*string

Registry type

Value in"internal""organization""transient""backup"
createdAt*string

Creation timestamp

Formatdate-time
updatedAt*string

Last update timestamp

Formatdate-time
curl -X POST 'http://localhost:3000/docker-registry' \  -H 'Content-Type: application/json' \  -d '{  "mtlsSecretArn": "mtlsSecretArn",  "password": "password",  "name": "name",  "project": "project",  "mtlsRoleArn": "mtlsRoleArn",  "url": "url",  "username": "username"}'
{  "mtlsSecretArn": "mtlsSecretArn",  "registryType": "internal",  "createdAt": "2024-01-31T12:00:00Z",  "name": "My Docker Hub",  "project": "my-project",  "id": "123e4567-e89b-12d3-a456-426614174000",  "url": "https://registry.hub.docker.com",  "mtlsRoleArn": "mtlsRoleArn",  "username": "username",  "updatedAt": "2024-01-31T12:00:00Z"}
GET
/docker-registry/registry-push-access

Authorization

headerAuthorizationBearer <token>

API Key access

Query Parameters

regionId?string

ID of the region where the snapshot will be available (defaults to organization default region)

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

Temporary registry access has been generated

application/json
  1. response
username*string

Temporary username for registry authentication

secret*string

Temporary secret for registry authentication

registryUrl*string

Registry URL

registryId*string

Registry ID

project*string

Registry project ID

expiresAt*string

Token expiration time in ISO format

curl -X GET 'http://localhost:3000/docker-registry/registry-push-access'
{  "registryUrl": "registry.example.com",  "registryId": "123e4567-e89b-12d3-a456-426614174000",  "project": "library",  "secret": "eyJhbGciOiJIUzI1NiIs...",  "expiresAt": "2023-12-31T23:59:59Z",  "username": "temp-user-123"}

Get registry

GET
/docker-registry/{id}

Authorization

headerAuthorizationBearer <token>

API Key access

Path Parameters

id*string

ID of the docker registry

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

The docker registry

application/json
  1. response
id*string

Registry ID

name*string

Registry name

url*string

Registry URL

username*string

Registry username

mtlsRoleArn*|

IAM role ARN for registry mTLS

mtlsSecretArn*|

Secrets Manager ARN for registry mTLS

project*string

Registry project

registryType*string

Registry type

Value in"internal""organization""transient""backup"
createdAt*string

Creation timestamp

Formatdate-time
updatedAt*string

Last update timestamp

Formatdate-time
curl -X GET 'http://localhost:3000/docker-registry/string'
{  "mtlsSecretArn": "mtlsSecretArn",  "registryType": "internal",  "createdAt": "2024-01-31T12:00:00Z",  "name": "My Docker Hub",  "project": "my-project",  "id": "123e4567-e89b-12d3-a456-426614174000",  "url": "https://registry.hub.docker.com",  "mtlsRoleArn": "mtlsRoleArn",  "username": "username",  "updatedAt": "2024-01-31T12:00:00Z"}

Update registry

PATCH
/docker-registry/{id}

Authorization

headerAuthorizationBearer <token>

API Key access

Path Parameters

id*string

ID of the docker registry

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Request Body

application/json
  1. body
mtlsRoleArn?|

IAM role ARN for registry mTLS; supply with mtlsSecretArn, or set both to null to clear

mtlsSecretArn?|

Secrets Manager ARN for registry mTLS; supply with mtlsRoleArn, or set both to null to clear

name*string

Registry name

url*string

Registry URL

username*string

Registry username

password?string

Registry password

project?string

Registry project

Response Body

The docker registry has been successfully updated.

application/json
  1. response
id*string

Registry ID

name*string

Registry name

url*string

Registry URL

username*string

Registry username

mtlsRoleArn*|

IAM role ARN for registry mTLS

mtlsSecretArn*|

Secrets Manager ARN for registry mTLS

project*string

Registry project

registryType*string

Registry type

Value in"internal""organization""transient""backup"
createdAt*string

Creation timestamp

Formatdate-time
updatedAt*string

Last update timestamp

Formatdate-time
curl -X PATCH 'http://localhost:3000/docker-registry/string' \  -H 'Content-Type: application/json' \  -d '{  "mtlsSecretArn": "mtlsSecretArn",  "password": "password",  "name": "name",  "project": "project",  "mtlsRoleArn": "mtlsRoleArn",  "url": "url",  "username": "username"}'
{  "mtlsSecretArn": "mtlsSecretArn",  "registryType": "internal",  "createdAt": "2024-01-31T12:00:00Z",  "name": "My Docker Hub",  "project": "my-project",  "id": "123e4567-e89b-12d3-a456-426614174000",  "url": "https://registry.hub.docker.com",  "mtlsRoleArn": "mtlsRoleArn",  "username": "username",  "updatedAt": "2024-01-31T12:00:00Z"}

Delete registry

DELETE
/docker-registry/{id}

Authorization

headerAuthorizationBearer <token>

API Key access

Path Parameters

id*string

ID of the docker registry

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

The docker registry has been successfully deleted.

curl -X DELETE 'http://localhost:3000/docker-registry/string'
Empty