Updated on 2025-12-05 GMT+08:00

Creating a Docker Registry

Function

This API is used to create a Docker registry.

Calling Method

For details, see Calling APIs.

URI

POST /cloudartifact/v5/repositories

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

format

Yes

String

Definition

Package type.

Constraints

N/A.

Range

Docker

Default value

None

display_name

Yes

String

Definition

Repository display name.

Constraints

The value can contain up to 20 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are supported.

Range

N/A.

Default value

None

description

No

String

Definition

Repository description.

Constraints

Maximum length: 200 characters.

Range

N/A.

Default value

None

type

Yes

String

Definition

Repository type.

Constraints

N/A.

Range

hosted: local repository

Default value

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

status

String

Definition

Request status.

Range

success: The request is successful.

error: The request fails.

trace_id

String

Definition

Request ID, which uniquely identifies the current request.

Range

A string of digits and hyphens (-).

result

Object

Definition

Response of the request. The return value varies according to the API.

Range

The value range varies according to the API.

Example Requests

This API is used to request example for creating a Docker registry.

/v5/repositories

{
  "format" : "docker",
  "display_name" : "string",
  "description" : "string",
  "type" : "Hosted"
}

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "trace_id" : "143002-1701175561381-82",
  "result" : null
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.