​

ves-io-schema-tpm_api_key-API-Create

Published April 5, 2023 | Last modified November 14, 2025

Examples of creating tpm_api_key

Usecase:

Create "tpm_api_key"

Request using vesctl:

vesctl configuration create tpm_api_key -i tpm_api_key.yaml

where file tpm_api_key.yaml has following contents (tpm_api_key.CreateRequest):

RequestJSON:

{
    "metadata": {
        "name": "apikey1",
        "namespace": "documentation"
    },
    "spec": {
        "category_ref": [
            {
                "namespace": "documentation",
                "name": "category-sku-001"
            }
        ]
    }
}
Copied!

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "apikey1",
        "namespace": "documentation",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "3efcc0dd-ea50-4880-87cb-40bb64dec04e",
        "creation_timestamp": "2025-11-13T23:08:00.524075Z",
        "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": "ffffffff-ffff-ffff-ffff-ffffffffffff",
                "tenant": "acmecorp",
                "namespace": "documentation",
                "name": "category-sku-001"
            }
        ],
        "need_mtls": false,
        "apikey": "",
        "revoked_timestamp": null,
        "revoke_reason": "",
        "is_disabled": false
    }
}
Copied!

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"apikey1","namespace":"documentation"},"spec":{"category_ref":[{"namespace":"documentation","name":"category-sku-001"}]}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build4194363419_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/tpm/namespaces/documentation/tpm_api_keys'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 976
Content-Type: application/json
Date: Thu, 13 Nov 2025 23:08:00 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "apikey1",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "3efcc0dd-ea50-4880-87cb-40bb64dec04e",
    "creation_timestamp": "2025-11-13T23:08:00.524075Z",
    "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": "ffffffff-ffff-ffff-ffff-ffffffffffff",
        "tenant": "acmecorp",
        "namespace": "documentation",
        "name": "category-sku-001"
      }
    ],
    "need_mtls": false,
    "apikey": "",
    "revoked_timestamp": null,
    "revoke_reason": "",
    "is_disabled": false
  }
}
Copied!
On this page: