Own Docker? Customize your docs with AI search, analytics, and more.

POST

Create an image

/v1.33/images/create

Create an image by either pulling it from a registry or importing it.

Access Token Required: API Key

Query Params

fromImagestring

Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed.

fromSrcstring

Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image.

repostring

Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.

tagstring

Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/images/create' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Create an image

/v1.33/images/create

Create an image by either pulling it from a registry or importing it.

Access Token Required: API Key

Query Params

fromImagestring

Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed.

fromSrcstring

Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image.

repostring

Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.

tagstring

Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/images/create' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Create an image

/v1.33/images/create

Create an image by either pulling it from a registry or importing it.

Access Token Required: API Key

Query Params

fromImagestring

Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed.

fromSrcstring

Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image.

repostring

Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.

tagstring

Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/images/create' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Create an image

/v1.33/images/create

Create an image by either pulling it from a registry or importing it.

Access Token Required: API Key

Query Params

fromImagestring

Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed.

fromSrcstring

Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image.

repostring

Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.

tagstring

Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/images/create' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}