Registries

APIs to create, update, list registries

Create Registry.

Create a Registry.

Securityx-api-key

Request

query Parameters

space_ref

string

Reference to the scope in which the registry exists.

Format depends on the scope:

Account-level: account_id/+
Organization-level: account_id/org/+
Project-level: account_id/org/project/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Examples:

Account-level registry

Only account ID, scoped at account level

space_ref=acc123/+

Organization-level registry

Account and org, scoped at org level

space_ref=acc123/org456/+

Project-level registry

Account, org, and project, scoped at project level

space_ref=acc123/org456/proj789/+

Request Body schema: application/json

request for create and update registry

allowedPattern	Array of strings
blockedPattern	Array of strings
	Array of objects (CleanupPolicy)
	object (RegistryConfig) SubConfig specific for Virtual or Upstream Registry
description	string
identifier required	string
labels	Array of strings
packageType required	string (PackageType) refers to package Enum: "DOCKER" "MAVEN" "PYTHON" "GENERIC" "HELM" "NUGET" "NPM" "RPM" "CARGO" "GO" "HUGGINGFACE"
parentRef	string Reference to the scope in which the registry exists. Format depends on the scope: Account-level: `account_id` Organization-level: `account_id/org_id` Project-level: `account_id/org_id/project_id`
	Array of objects (Scanner)

Responses

201

response for create, get and update registry

400

Bad request

401

Unauthenticated

403

Unauthorized

500

Internal server error

post/har/api/v1/registry

Request samples

Payload
curl
Java
Go

application/json

{"allowedPattern": ["string"
],
"blockedPattern": ["string"
],
"cleanupPolicy": [{"expireDays": 0,
"name": "string",
"packagePrefix": ["string"
],
"versionPrefix": ["string"
]
}
],
"config": {"type": "VIRTUAL",
"upstreamProxies": ["string"
]
},
"description": "string",
"identifier": "string",
"labels": ["string"
],
"packageType": "DOCKER",
"parentRef": "string",
"scanners": [{"name": "AQUA_TRIVY"
}
]
}

Response samples

application/json

{"data": {"allowedPattern": ["string"
],
"blockedPattern": ["string"
],
"cleanupPolicy": [{"expireDays": 0,
"name": "string",
"packagePrefix": ["string"
],
"versionPrefix": ["string"
]
}
],
"config": {"type": "VIRTUAL",
"upstreamProxies": ["string"
]
},
"createdAt": "string",
"description": "string",
"identifier": "string",
"labels": ["string"
],
"modifiedAt": "string",
"packageType": "DOCKER",
"scanners": [{"name": "AQUA_TRIVY"
}
],
"url": "string"
},
"status": "SUCCESS"
}

Delete a Registry

Delete a Registry in the account for the given key

Securityx-api-key

Request

path Parameters

registry_ref

required

string

Reference to the scope in which the registry exists.

Format depends on the scope:

Account-level: account_id/registry_name/+
Organization-level: account_id/org_id/registry_name/+
Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Examples:

Account-level registry

Only account ID, scoped at account level

acc123/registry123/+

Organization-level registry

Account and org ID, scoped at org level

acc123/org456/registry123/+

Project-level registry

Account, org, and project ID, scoped at project level

acc123/org456/proj789/registry123/+

Responses

200

Success Response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

delete/har/api/v1/registry/{registry_ref}

Request samples

curl
Java
Go

Response samples

application/json

{"status": "SUCCESS"
}

Returns Registry Details

Returns Registry Details in the account for the given key

Securityx-api-key

Request

path Parameters

registry_ref

required

string

Reference to the scope in which the registry exists.

Format depends on the scope:

Account-level: account_id/registry_name/+
Organization-level: account_id/org_id/registry_name/+
Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Examples:

Account-level registry

Only account ID, scoped at account level

acc123/registry123/+

Organization-level registry

Account and org ID, scoped at org level

acc123/org456/registry123/+

Project-level registry

Account, org, and project ID, scoped at project level

acc123/org456/proj789/registry123/+

Responses

200

response for create, get and update registry

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_ref}

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"allowedPattern": ["string"
],
"blockedPattern": ["string"
],
"cleanupPolicy": [{"expireDays": 0,
"name": "string",
"packagePrefix": ["string"
],
"versionPrefix": ["string"
]
}
],
"config": {"type": "VIRTUAL",
"upstreamProxies": ["string"
]
},
"createdAt": "string",
"description": "string",
"identifier": "string",
"labels": ["string"
],
"modifiedAt": "string",
"packageType": "DOCKER",
"scanners": [{"name": "AQUA_TRIVY"
}
],
"url": "string"
},
"status": "SUCCESS"
}

Updates a Registry

Updates a Registry in the account for the given key

Securityx-api-key

Request

path Parameters

registry_ref

required

string

Reference to the scope in which the registry exists.

Format depends on the scope:

Account-level: account_id/registry_name/+
Organization-level: account_id/org_id/registry_name/+
Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Examples:

Account-level registry

Only account ID, scoped at account level

acc123/registry123/+

Organization-level registry

Account and org ID, scoped at org level

acc123/org456/registry123/+

Project-level registry

Account, org, and project ID, scoped at project level

acc123/org456/proj789/registry123/+

Request Body schema: application/json

request for create and update registry

allowedPattern	Array of strings
blockedPattern	Array of strings
	Array of objects (CleanupPolicy)
	object (RegistryConfig) SubConfig specific for Virtual or Upstream Registry
description	string
identifier required	string
labels	Array of strings
packageType required	string (PackageType) refers to package Enum: "DOCKER" "MAVEN" "PYTHON" "GENERIC" "HELM" "NUGET" "NPM" "RPM" "CARGO" "GO" "HUGGINGFACE"
parentRef	string Reference to the scope in which the registry exists. Format depends on the scope: Account-level: `account_id` Organization-level: `account_id/org_id` Project-level: `account_id/org_id/project_id`
	Array of objects (Scanner)

Responses

200

response for create, get and update registry

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

put/har/api/v1/registry/{registry_ref}

Request samples

Payload
curl
Java
Go

application/json

{"allowedPattern": ["string"
],
"blockedPattern": ["string"
],
"cleanupPolicy": [{"expireDays": 0,
"name": "string",
"packagePrefix": ["string"
],
"versionPrefix": ["string"
]
}
],
"config": {"type": "VIRTUAL",
"upstreamProxies": ["string"
]
},
"description": "string",
"identifier": "string",
"labels": ["string"
],
"packageType": "DOCKER",
"parentRef": "string",
"scanners": [{"name": "AQUA_TRIVY"
}
]
}

Response samples

application/json

{"data": {"allowedPattern": ["string"
],
"blockedPattern": ["string"
],
"cleanupPolicy": [{"expireDays": 0,
"name": "string",
"packagePrefix": ["string"
],
"versionPrefix": ["string"
]
}
],
"config": {"type": "VIRTUAL",
"upstreamProxies": ["string"
]
},
"createdAt": "string",
"description": "string",
"identifier": "string",
"labels": ["string"
],
"modifiedAt": "string",
"packageType": "DOCKER",
"scanners": [{"name": "AQUA_TRIVY"
}
],
"url": "string"
},
"status": "SUCCESS"
}

List Artifacts for Registry

Lists all the Artifacts for Registry

Securityx-api-key

Request

path Parameters

registry_ref

required

string

Reference to the scope in which the registry exists.

Format depends on the scope:

Account-level: account_id/registry_name/+
Organization-level: account_id/org_id/registry_name/+
Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Examples:

Account-level registry

Only account ID, scoped at account level

acc123/registry123/+

Organization-level registry

Account and org ID, scoped at org level

acc123/org456/registry123/+

Project-level registry

Account, org, and project ID, scoped at project level

acc123/org456/proj789/registry123/+

query Parameters

label	Array of strings Label.
page	integer <int64> Default: 1 Current page number
size	integer <int64> Default: 20 Number of items per page
sort_order	string sortOrder
sort_field	string sortField
search_term	string search Term.
artifact_type	string artifact type. Enum: "model" "dataset"

Responses

200

response for list artifact

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_ref}/artifacts

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"artifacts": [{"artifactType": "model",
"downloadsCount": 0,
"isQuarantined": true,
"labels": ["string"
],
"lastModified": "string",
"latestVersion": "string",
"name": "string",
"packageType": "DOCKER",
"registryIdentifier": "string",
"registryPath": "string"
}
],
"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1
},
"status": "SUCCESS"
}

Returns CLI Client Setup Details

Returns CLI Client Setup Details based on package type

Securityx-api-key

Request

path Parameters

registry_ref

required

string

Reference to the scope in which the registry exists.

Format depends on the scope:

Account-level: account_id/registry_name/+
Organization-level: account_id/org_id/registry_name/+
Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Examples:

Account-level registry

Only account ID, scoped at account level

acc123/registry123/+

Organization-level registry

Account and org ID, scoped at org level

acc123/org456/registry123/+

Project-level registry

Account, org, and project ID, scoped at project level

acc123/org456/proj789/registry123/+

query Parameters

artifact	string Artifat
version	string Version

Responses

200

response for client setup details

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_ref}/client-setup-details

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"mainHeader": "string",
"secHeader": "string",
"sections": [{"header": "string",
"secHeader": "string",
"type": "INLINE",
"steps": [{"commands": [{"label": null,
"value": null
}
],
"header": "string",
"type": "Static"
}
]
}
]
},
"status": "SUCCESS"
}

➔ Next to Artifacts