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

PUT

Extract an archive of files or folders to a directory in a container

/v1.33/containers/{id}/archive

Upload a tar archive to be extracted to a path in the filesystem of container id.

Access Token Required: API Key

Path Parameters

idstringrequired

ID or name of the container

Query Params

pathstringrequired

Path to a directory in the container to extract the archive’s contents into.

noOverwriteDirNonDirstring

If “1”, “true”, or “True” then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa.

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 PUT \
2     --url '/v1.33/containers/{id}/archive' \
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}

PUT

Extract an archive of files or folders to a directory in a container

/v1.33/containers/{id}/archive

Upload a tar archive to be extracted to a path in the filesystem of container id.

Access Token Required: API Key

Path Parameters

idstringrequired

ID or name of the container

Query Params

pathstringrequired

Path to a directory in the container to extract the archive’s contents into.

noOverwriteDirNonDirstring

If “1”, “true”, or “True” then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa.

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 PUT \
2     --url '/v1.33/containers/{id}/archive' \
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}

PUT

Extract an archive of files or folders to a directory in a container

/v1.33/containers/{id}/archive

Upload a tar archive to be extracted to a path in the filesystem of container id.

Access Token Required: API Key

Path Parameters

idstringrequired

ID or name of the container

Query Params

pathstringrequired

Path to a directory in the container to extract the archive’s contents into.

noOverwriteDirNonDirstring

If “1”, “true”, or “True” then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa.

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 PUT \
2     --url '/v1.33/containers/{id}/archive' \
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}

PUT

Extract an archive of files or folders to a directory in a container

/v1.33/containers/{id}/archive

Upload a tar archive to be extracted to a path in the filesystem of container id.

Access Token Required: API Key

Path Parameters

idstringrequired

ID or name of the container

Query Params

pathstringrequired

Path to a directory in the container to extract the archive’s contents into.

noOverwriteDirNonDirstring

If “1”, “true”, or “True” then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa.

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 PUT \
2     --url '/v1.33/containers/{id}/archive' \
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}