Run:AI

Credentials

Credentials are used to unlock protected resources such as applications, containers, and other assets. For more information, see Credentials.

List credentials.

Use to retrieve a list of all existing credentials.

SecuritybearerAuth
Request
query Parameters
name
string

Filter results by name.

scope
string

Filter results by scope.

projectId
integer <int32>

Filter results by project id. if scope filter is project, only assets from the specific project will be included in the response. otherwise, the response will include both project, department, cluster and tenant assets.

departmentId
string

Filter using the department id.

Example: departmentId=1
clusterId
string <uuid>

Filter using the Universally Unique Identifier (UUID) of the cluster.

Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo
boolean

Whether the query should include asset usage information as part of the response.

statusInfo
boolean

Whether the query should include asset status information as part of the response.

Responses
200

Request completed successfully.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/credentials
Response samples
application/json
{
  • "entries": [
    ]
}

List access keys.

Use to retrieve a list of S3-compatible access key credentials.

SecuritybearerAuth
Request
query Parameters
name
string

Filter results by name.

scope
string

Filter results by scope.

projectId
integer <int32>

Filter results by project id. if scope filter is project, only assets from the specific project will be included in the response. otherwise, the response will include both project, department, cluster and tenant assets.

departmentId
string

Filter using the department id.

Example: departmentId=1
clusterId
string <uuid>

Filter using the Universally Unique Identifier (UUID) of the cluster.

Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo
boolean

Whether the query should include asset usage information as part of the response.

statusInfo
boolean

Whether the query should include asset status information as part of the response.

Responses
200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/credentials/access-key
Response samples
application/json
{
  • "entries": [
    ]
}

Create an access key.

Use to create an S3-compatible access key credential.

SecuritybearerAuth
Request
Request Body schema: application/json
required
required
object (AssetCreationRequest)
required
object (AccessKeyCreationSpec)
Responses
202

Request accepted successfully.

400

Bad request.

401

Unauthorized

409

The specified resource already exists

503

unexpected error

post/api/v1/asset/credentials/access-key
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Get an access key.

Use to retrieve the details of an S3-compatible access key credential by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

query Parameters
usageInfo
boolean

Whether the query should include asset usage information as part of the response.

statusInfo
boolean

Whether the query should include asset status information as part of the response.

Responses
200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

get/api/v1/asset/credentials/access-key/{AssetId}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Update an access key.

Use to update the details of an S3-compatible access key credential by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json
required
required
object (AssetUpdateRequest)
Responses
202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

put/api/v1/asset/credentials/access-key/{AssetId}
Request samples
application/json
{
  • "meta": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Delete an access key.

Use to delete an S3-compatible access key credential by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

Responses
202

Accepted.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

412

The specified resource was not found.

503

unexpected error

delete/api/v1/asset/credentials/access-key/{AssetId}
Response samples
application/json
{
  • "code": 202,
  • "message": "Request has been accepted."
}

List password credentials.

Use to retrieve a list of password credentials.

SecuritybearerAuth
Request
query Parameters
name
string

Filter results by name.

scope
string

Filter results by scope.

projectId
integer <int32>

Filter results by project id. if scope filter is project, only assets from the specific project will be included in the response. otherwise, the response will include both project, department, cluster and tenant assets.

departmentId
string

Filter using the department id.

Example: departmentId=1
clusterId
string <uuid>

Filter using the Universally Unique Identifier (UUID) of the cluster.

Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo
boolean

Whether the query should include asset usage information as part of the response.

statusInfo
boolean

Whether the query should include asset status information as part of the response.

Responses
200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/credentials/password
Response samples
application/json
{
  • "entries": [
    ]
}

Create a userid / password credential.

Use to create a userid / password credential.

SecuritybearerAuth
Request
Request Body schema: application/json
required
required
object (AssetCreationRequest)
required
object (PasswordCreationSpec)
Responses
202

Request accepted successfully.

400

Bad request.

401

Unauthorized

409

The specified resource already exists

503

unexpected error

post/api/v1/asset/credentials/password
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Get a userid / password credential.

Use to retrieve the details of a userid / password credential asset by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

query Parameters
usageInfo
boolean

Whether the query should include asset usage information as part of the response.

statusInfo
boolean

Whether the query should include asset status information as part of the response.

Responses
200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

get/api/v1/asset/credentials/password/{AssetId}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Update a password credential.

Use to Update the details of a password credential by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json
required
required
object (AssetUpdateRequest)
Responses
202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

put/api/v1/asset/credentials/password/{AssetId}
Request samples
application/json
{
  • "meta": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Delete a password asset.

Udse to delete a password credential by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

Responses
202

Accepted.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

412

The specified resource was not found.

503

unexpected error

delete/api/v1/asset/credentials/password/{AssetId}
Response samples
application/json
{
  • "code": 202,
  • "message": "Request has been accepted."
}

List docker registry credentials.

Use to retrieve a list of docker registry credentials.

SecuritybearerAuth
Request
query Parameters
name
string

Filter results by name.

scope
string

Filter results by scope.

projectId
integer <int32>

Filter results by project id. if scope filter is project, only assets from the specific project will be included in the response. otherwise, the response will include both project, department, cluster and tenant assets.

departmentId
string

Filter using the department id.

Example: departmentId=1
clusterId
string <uuid>

Filter using the Universally Unique Identifier (UUID) of the cluster.

Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo
boolean

Whether the query should include asset usage information as part of the response.

statusInfo
boolean

Whether the query should include asset status information as part of the response.

Responses
200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/credentials/docker-registry
Response samples
application/json
{
  • "entries": [
    ]
}

Create a docker registry credential.

Use to create a docker registry credential containing userid, password and url.

SecuritybearerAuth
Request
Request Body schema: application/json
required
required
object (AssetCreationRequest)
required
object (DockerRegistryCreationSpec)
Responses
202

Request accepted successfully.

400

Bad request.

401

Unauthorized

409

The specified resource already exists

503

unexpected error

post/api/v1/asset/credentials/docker-registry
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Get a docker registry credential.

Use to retrieve the details of a docker registry credential by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

query Parameters
usageInfo
boolean

Whether the query should include asset usage information as part of the response.

statusInfo
boolean

Whether the query should include asset status information as part of the response.

Responses
200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

get/api/v1/asset/credentials/docker-registry/{AssetId}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Update a docker registry credential.

Use to updates the details of a docker registry credentials by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json
required
required
object (AssetUpdateRequest)
Responses
202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

put/api/v1/asset/credentials/docker-registry/{AssetId}
Request samples
application/json
{
  • "meta": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Delete a docker registry credential.

Use to deletes a docker registry credential by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

Responses
202

Accepted.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

412

The specified resource was not found.

503

unexpected error

delete/api/v1/asset/credentials/docker-registry/{AssetId}
Response samples
application/json
{
  • "code": 202,
  • "message": "Request has been accepted."
}

List generic-secrets.

Retrieve a list of generic-secret assets.

SecuritybearerAuth
Request
query Parameters
name
string

Filter results by name.

scope
string

Filter results by scope.

projectId
integer <int32>

Filter results by project id. if scope filter is project, only assets from the specific project will be included in the response. otherwise, the response will include both project, department, cluster and tenant assets.

departmentId
string

Filter using the department id.

Example: departmentId=1
clusterId
string <uuid>

Filter using the Universally Unique Identifier (UUID) of the cluster.

Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo
boolean

Whether the query should include asset usage information as part of the response.

statusInfo
boolean

Whether the query should include asset status information as part of the response.

Responses
200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/credentials/generic-secret
Response samples
application/json
{
  • "entries": [
    ]
}

Create a generic-secret.

Use to create a generic-secret asset.

SecuritybearerAuth
Request
Request Body schema: application/json
required
required
object (AssetCreationRequest)
required
object (GenericSecretCreationSpec)
Responses
202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

409

The specified resource already exists

503

unexpected error

post/api/v1/asset/credentials/generic-secret
Request samples
application/json
{
  • "meta": {
    },
  • "spec": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Get a generic-secret.

Returns the details of a generic-secret asset, by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

query Parameters
usageInfo
boolean

Whether the query should include asset usage information as part of the response.

statusInfo
boolean

Whether the query should include asset status information as part of the response.

Responses
200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

get/api/v1/asset/credentials/generic-secret/{AssetId}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Update a generic-secret.

Updates the details of a generic-secret asset, by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json
required
required
object (AssetUpdateRequest)
Responses
202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

put/api/v1/asset/credentials/generic-secret/{AssetId}
Request samples
application/json
{
  • "meta": {
    }
}
Response samples
application/json
{
  • "meta": {
    },
  • "spec": {
    },
  • "usedBy": {
    },
  • "compliance": {
    },
  • "status": {
    }
}

Delete a generic-secret.

Use to delete a generic-secret asset, by id.

SecuritybearerAuth
Request
path Parameters
AssetId
required
string <uuid> non-empty

Unique identifier of the asset.

Responses
204

No Content.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

412

The specified resource was not found.

503

unexpected error

delete/api/v1/asset/credentials/generic-secret/{AssetId}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}
➔ Next to Datasources