Skip to content

API Credential

It is used to revoke multiple API credentials. This API would disable the credentials and mark them for deletion. The actual removal of objects would be done in the background. Depending upon if user is admin or not, following behaviour is supported:-

  • for admins : user has the access to DELETE their own as well as credentials created by others
  • for non-admins: user can only DELETE their own credentials.
ToolDescription
f5xc-api-authentication-api-credential-createBulk Revoke API credentials.
f5xc-api-authentication-api-credential-getGET API Credentials.
f5xc-api-authentication-api-credential-listList API Credentials.
ParameterDescriptionExample
nameCredential name-
namespaceNamespace-

Ask Claude to help you work with API Credential resources:

“Create a api-credential named ‘example’ in the ‘production’ namespace”

“List all api-credentials in the ‘production’ namespace”

“Get details of the api-credential named ‘example’ in namespace ‘production‘“

Terminal window
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/api_credentials" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json"
# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/api_credentials/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json"
# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/api_credentials" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @api_credential.json
# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/api_credentials/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"