​

ves-io-schema-api_sec-api_testing-API-Create

Published April 5, 2023 | Last modified September 19, 2025

Examples of creating api_testing

Usecase:

Create "book" api_testing that marks author and book field as sensitive data

Request using vesctl:

vesctl configuration create api_testing -i api_testing.yaml

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

RequestJSON:

{
    "metadata": {
        "name": "book",
        "namespace": "documentation"
    },
    "spec": {
        "domains": [
            {
                "domain": "test-example.com",
                "allow_destructive_methods": true,
                "credentials": [
                    {
                        "credential_name": "testUser",
                        "basic_auth": {
                            "user": "testUser",
                            "password": {
                                "clear_secret_info": {
                                    "url": "string://\u003cbase64-password\u003e"
                                }
                            }
                        },
                        "standard": null
                    }
                ]
            }
        ],
        "custom_header_value": "x-f5-api-testing-identifier",
        "every_week": {}
    }
}
Copied!

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "book",
        "namespace": "documentation",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "54135534-9222-4be6-a69c-7a99344581f3",
        "creation_timestamp": "2025-09-19T01:59:37.135458Z",
        "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": {
        "domains": [
            {
                "domain": "test-example.com",
                "allow_destructive_methods": true,
                "credentials": [
                    {
                        "credential_name": "testUser",
                        "basic_auth": {
                            "user": "testUser",
                            "password": {
                                "clear_secret_info": {
                                    "provider": "",
                                    "url": "string://\u003cbase64-password\u003e"
                                },
                                "blindfold_secret_info_internal": null,
                                "secret_encoding_type": "EncodingNone"
                            }
                        }
                    }
                ]
            }
        ],
        "custom_header_value": "x-f5-api-testing-identifier",
        "every_week": {}
    }
}
Copied!

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"book","namespace":"documentation"},"spec":{"domains":[{"domain":"test-example.com","allow_destructive_methods":true,"credentials":[{"credential_name":"testUser","basic_auth":{"user":"testUser","password":{"clear_secret_info":{"url":"string://\u003cbase64-password\u003e"}}},"standard":null}]}],"custom_header_value":"x-f5-api-testing-identifier","every_week":{}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build2850427035_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/api_testings'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 1303
Content-Type: application/json
Date: Fri, 19 Sep 2025 01:59:37 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "book",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "54135534-9222-4be6-a69c-7a99344581f3",
    "creation_timestamp": "2025-09-19T01:59:37.135458Z",
    "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": {
    "domains": [
      {
        "domain": "test-example.com",
        "allow_destructive_methods": true,
        "credentials": [
          {
            "credential_name": "testUser",
            "basic_auth": {
              "user": "testUser",
              "password": {
                "clear_secret_info": {
                  "provider": "",
                  "url": "string://\u003cbase64-password\u003e"
                },
                "blindfold_secret_info_internal": null,
                "secret_encoding_type": "EncodingNone"
              }
            }
          }
        ]
      }
    ],
    "custom_header_value": "x-f5-api-testing-identifier",
    "every_week": {

    }
  }
}
Copied!
On this page: