​

ves-io-schema-contact-API-Create

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

Examples of creating contact

Usecase:

Create contact-1

Request using vesctl:

vesctl configuration create contact -i contact.yaml

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

RequestJSON:

{
    "metadata": {
        "name": "contact-1",
        "namespace": "documentation"
    },
    "spec": {}
}
Copied!

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "contact-1",
        "namespace": "documentation",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "d059a93c-d794-44ae-90bf-c4ec9ca2daa9",
        "creation_timestamp": "2025-05-30T01:19:58.232532Z",
        "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": {
        "contact_type": "MAILING",
        "phone_number": "",
        "address1": "",
        "address2": "",
        "city": "",
        "county": "",
        "state": "",
        "state_code": "",
        "country": "",
        "zip_code": ""
    }
}
Copied!

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"contact-1","namespace":"documentation"},"spec":{}}' -H 'Content-Type: application/json' -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/web/namespaces/documentation/contacts'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 819
Content-Type: application/json
Date: Fri, 30 May 2025 01:19:58 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "contact-1",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "d059a93c-d794-44ae-90bf-c4ec9ca2daa9",
    "creation_timestamp": "2025-05-30T01:19:58.232532Z",
    "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": {
    "contact_type": "MAILING",
    "phone_number": "",
    "address1": "",
    "address2": "",
    "city": "",
    "county": "",
    "state": "",
    "state_code": "",
    "country": "",
    "zip_code": ""
  }
}
Copied!
On this page: