​

ves-io-schema-api_credential-CustomAPI-List

Published April 5, 2023 | Last modified May 17, 2026

Examples of performing api_credential CustomAPI List

Usecase:

Create kubeconfig for vk8s-documentation for user-1

Request:

Request using vesctl:

vesctl request rpc api_credential.CustomAPI.List -i request.yaml --uri /public/namespaces/system/api_credentials --http-method POST

where file request.yaml has following contents:

expirationDays: 20
name: user-1-kubeconfig
namespace: documentation
spec:
  type: KUBE_CONFIG
  virtualK8sName: vk8s-documentation
  virtualK8sNamespace: documentation

vesctl yaml response:

{}

Request using curl:

curl -X 'POST' -d '{"namespace":"documentation","name":"user-1-kubeconfig","spec":{"type":"KUBE_CONFIG","virtual_k8s_namespace":"documentation","virtual_k8s_name":"vk8s-documentation"},"expiration_days":20}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1414723615_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/web/namespaces/system/api_credentials'

curl response:

HTTP/1.1 200 OK
Content-Length: 81
Content-Type: application/json
Date: Mon, 13 Apr 2026 01:59:00 GMT
Vary: Accept-Encoding


{
  "data": "",
  "name": "",
  "active": false,
  "expiration_timestamp": null
}

Usecase:

Create client certificate for user-1 of acmecorp

Request:

Request using vesctl:

vesctl request rpc api_credential.CustomAPI.List -i request.yaml --uri /public/namespaces/system/api_credentials --http-method POST

where file request.yaml has following contents:

expirationDays: 20
name: user-1-cert
namespace: documentation
spec:
  password: testP@sswd123

vesctl yaml response:

{}

Request using curl:

curl -X 'POST' -d '{"namespace":"documentation","name":"user-1-cert","spec":{"password":"testP@sswd123"},"expiration_days":20}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1414723615_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/web/namespaces/system/api_credentials'

curl response:

HTTP/1.1 200 OK
Content-Length: 81
Content-Type: application/json
Date: Mon, 13 Apr 2026 01:59:00 GMT
Vary: Accept-Encoding


{
  "data": "",
  "name": "",
  "active": false,
  "expiration_timestamp": null
}

Usecase:

List API credentials created by the user for given tenant

Request:

Request using vesctl:

vesctl request rpc api_credential.CustomAPI.List -i request.yaml --uri /public/namespaces/system/api_credentials --http-method POST

where file request.yaml has following contents:

namespace: system

vesctl yaml response:

{}

Request using curl:

curl -X 'POST' -d '{"namespace":"system"}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1414723615_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/web/namespaces/system/api_credentials'

curl response:

HTTP/1.1 200 OK
Content-Length: 81
Content-Type: application/json
Date: Mon, 13 Apr 2026 01:59:00 GMT
Vary: Accept-Encoding


{
  "data": "",
  "name": "",
  "active": false,
  "expiration_timestamp": null
}
On this page: