You need to enable JavaScript to run this app.
Container Registry

Container Registry

Copy page
Download PDF
Repository Management
CreateArtifactRegistry
Copy page
Download PDF
CreateArtifactRegistry
Create an artifact repository instance.​
Request description​
  • Request method: POST​
  • Request URL: https://open.volcengineapi.com/?Action=CreateArtifactRegistry&Version=2025-01-01​
Request parameters​
​
Parameter Name​
Type​
Required​
Sample value​
Description​
Action​
String​
Yes​
CreateArtifactRegistry​
The API name. The name of the current API is CreateArtifactRegistry.​
Version​
String​
Yes​
2025-01-01​
The API version. The current version of the API is 2025-01-01.​
Name​
String​
Yes​
artifact-demo​
Artifact repository name. The string must be between 3 and 30 characters long and may contain lowercase letters, numbers, and separators.-.​
tip​
  • A digit cannot be at the beginning, and a separator cannot be at the beginning or end.​
  • Region-level uniqueness​
Format​
String​
Yes​
Generic​
The package type of the artifact repository. Possible values:​
  • Generic: Artifact repository of the Generic type.​
  • Maven: Artifact repository of Maven type.​
  • PyPI: PyPI-type artifact repository.​
  • NPM: An artifact repository of the NPM type.​
Mode​
String​
Yes​
Hosted​
Artifact repository mode, values:​
  • Hosted: Local repository, which is a standard artifact repository. It can provide functions for uploading and downloading packages, just like the official repository.​
  • Proxy: A proxy repository whose primary function is to provide proxy services for other repositories. It is mainly used to proxy official sources, offering secure and high-speed official package download capability.​
  • Group: Aggregate repository, provides logical aggregation and isolation for other types of repositories, allows multiple other types of repositories to be combined into a single group, and offers services through a unified URL.​
Public​
Bool​
None​
true​
Whether packages are publicly downloadable, possible values:​
  • true: Supports public download of packages.​
  • false: (Default value) Public download of packages is not supported.​
WritePolicy​
String​
Yes​
Allow​
The package release strategy of the artifact repository, possible values:​
  • Allow: Overwrite is permitted, that is, uploading packages with the same path is allowed.​
  • Deny: Read only. Uploading, updating, and deleting packages are prohibited.​
  • Once: Overwriting is prohibited, and uploading packages with the same path is not allowed.​
Description​
String​
None​
this is a maven artifact​
Description information of the artifact repository.​
MavenRegistryConfig​
Required when Format is Maven.​
-​
Maven-type repository configuration.​
ProxyRegistryConfig​
Required when Mode is set to Proxy.​
-​
Proxy repository configuration.​
GroupRegistryConfig​
Required when Mode is Group.​
-​
Aggregate repository configuration.​
​
Sample requests​
​
POST https://open.volcengineapi.com/?Action=CreateArtifactRegistry&Version=2025-01-01​
Content-Type: application/json​
{​
"Name": "artifact-demo",​
"Type": "Basic",​
"Format": "Maven",​
"Mode": "Hosted",​
"Public": "true",​
"WritePolicy": "Allow",​
"Description": "this is a maven artifact",​
"MavenRegistryConfig": {​
"VersionPolicy": "Release",​
"LayoutPolicy": "Strict"​
}​
}​
​
Response parameters​
This API has no proprietary response parameters, for public response parameters, refer to Response structure.​
Sample responses​
​
HTTP/1.1: 200 OK​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20250604110420****100232280022D31",​
"Action": "CreateArtifactRegistry",​
"Version": "2025-01-01",​
"Service": "artifacts",​
"Region": "cn-north-1"​
},​
"Result": {}​
}​
​
​
Last updated: 2025.10.24 11:20:40