Revoke API credential.

POST

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

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/example/revoke/api_credentials \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "namespace": "example" }'

• F5 Distributed Cloud Console

For API credential revoke/deletion.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace

x-required Value of namespace is always “system”.

Request Body^required

Media typeapplication/json

Get credential request

GET credential object with a given name.

object

name

Credential name

Name of API credential. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

Namespace

Value of namespace is always “system”. Required: YES.

string

>= 6 characters <= 1024 characters

Example^generated

{
  "name": "example",
  "namespace": "example"
}

Responses

200

A successful response.

Media typeapplication/json

API credential status response

API credential status response.

object

status

Status

Result status flag.

boolean format: boolean

>= 17 characters <= 17 characters

Example^generated

{
  "status": true
}

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