​

ves-io-schema-tpm_api_key-API-Get

Published April 5, 2023 | Last modified May 30, 2025

Examples of getting tpm_api_key

Usecase:

Get "tpm apikey" that was created in previous example

Request using vesctl:

vesctl configuration get tpm_api_key apikey1 --namespace documentation

vesctl yaml response:

deletedReferredObjects: []
disabledReferredObjects: []
metadata:
  annotations: {}
  labels: {}
  name: apikey1
  namespace: documentation
referringObjects: []
resourceVersion: "3452"
spec:
  categoryRef:
  - kind: tpm_category.Object
    name: category-sku-001
    namespace: documentation
    tenant: acmecorp
status: []
systemMetadata:
  creationTimestamp: "2025-05-30T01:22:29.770804Z"
  creatorClass: examplesvc
  creatorId: examplesvc
  finalizers: []
  labels: {}
  tenant: acmecorp
  uid: 501a4d67-18e8-4404-b82e-f2c973936943
Copied!

Request using curl:

curl -X 'GET' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1497866850_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/tpm/namespaces/documentation/tpm_api_keys/apikey1?response_format=0'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 1141
Content-Type: application/json
Date: Fri, 30 May 2025 01:22:29 GMT
Vary: Accept-Encoding

{
  "create_form": null,
  "replace_form": null,
  "resource_version": "3452",
  "metadata": {
    "name": "apikey1",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "501a4d67-18e8-4404-b82e-f2c973936943",
    "creation_timestamp": "2025-05-30T01:22:29.770804Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "category_ref": [
      {
        "kind": "tpm_category.Object",
        "uid": "",
        "tenant": "acmecorp",
        "namespace": "documentation",
        "name": "category-sku-001"
      }
    ],
    "need_mtls": false,
    "apikey": "",
    "revoked_timestamp": null,
    "revoke_reason": "",
    "is_disabled": false
  },
  "status": [
  ],
  "referring_objects": [
  ],
  "deleted_referred_objects": [
  ],
  "disabled_referred_objects": [
  ]
}
Copied!
On this page: