List API Credentials.

GET

/api/web/namespaces/{namespace}/api_credentials

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/example/api_credentials \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

Returns list of API credential of all types created by the user. Query will look into tenants system namespace.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Value of namespace is always “system”.

Responses

200

A successful response.

Media typeapplication/json

List credential response

Response of request to list all of users credential objects.

object

items

List of the credentials

List of credential items.

Array<object>

List Credential item

Each item of credential list request.

object

active

Active

Possibility to deactivate credential with no deletion.

boolean format: boolean

create_timestamp

Create timestamp

Create time of API credential.

string format: date-time

<= 1024 characters

expiry_timestamp

Expiry time

Expiry time of credential.

string format: date-time

<= 1024 characters

name

Credential name

Name of API credential object.

string

>= 6 characters <= 1024 characters

namespace

Namespace

Namespace of API credential object.

string

>= 6 characters <= 1024 characters

type

string

default: API_CERTIFICATE

Allowed values: API_CERTIFICATE KUBE_CONFIG API_TOKEN SERVICE_API_TOKEN SERVICE_API_CERTIFICATE SERVICE_KUBE_CONFIG SITE_GLOBAL_KUBE_CONFIG SCIM_API_TOKEN SERVICE_SITE_GLOBAL_KUBE_CONFIG

uid

uuid of the record

UUID of API credential object.

string format: uuid

>= 36 characters <= 1024 characters

user_email

Email of user

User email of user that requested credential .

string

<= 1024 characters

Example

{
  "items": [
    {
      "type": "API_CERTIFICATE"
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example