Artifact repository

List artifact repositories

GET/api/v2/databases/{database}/schemas/{schema}/artifact-repositories
List artifact repositories

Path Parameters

ParameterDescription
database string
Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases.
schema 
Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database.

Query Parameters

ParameterDescription
like string
Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWith string
Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimit integer
Parameter to limit the maximum number of rows returned by a command.
fromName string
Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.

Response

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create an artifact repository

POST/api/v2/databases/{database}/schemas/{schema}/artifact-repositories
Create an artifact repository

Query Parameters

ParameterDescription
createMode string
Parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Response

CodeDescription
200
Successful request.
202

Fetch an artifact repository

GET/api/v2/databases/{database}/schemas/{schema}/artifact-repositories/{name}
Fetch an artifact repository

Path Parameters

ParameterDescription
name 
Identifier (i.e. name) for the resource.

Response

CodeDescription
200
successful
202

Delete an artifact repository

DELETE/api/v2/databases/{database}/schemas/{schema}/artifact-repositories/{name}
Delete an artifact repository

Query Parameters

ParameterDescription
ifExists boolean
Parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response

CodeDescription
200
202

Create or update an artifact repository

PUT/api/v2/databases/{database}/schemas/{schema}/artifact-repositories/{name}
Create or update an artifact repository

Response

CodeDescription
200
202

Changes the name of an artifact repository

POST/api/v2/databases/{database}/schemas/{schema}/artifact-repositories/{name}:rename
Changes the name of an artifact repository

Query Parameters

ParameterDescription
targetDatabase string
Database of the target resource. Defaults to the source's database
targetSchema string
Schema of the target resource. Defaults to the source's schema
targetName string
Name of the target resource.

Response

CodeDescription
200
202
Language: English