​

ves-io-schema-views-workload-API-Create

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

Examples of creating workload

Usecase:

Create adservice workload

Request using vesctl:

vesctl configuration create workload -i workload.yaml

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

RequestJSON:

{
    "metadata": {
        "name": "adservice",
        "namespace": "documentation"
    },
    "spec": {
        "simple_service": {
            "container": {
                "name": "adservice",
                "image": {
                    "name": "adservice:latest",
                    "public": {}
                }
            },
            "do_not_advertise": {},
            "disabled": {}
        }
    }
}
Copied!

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "adservice",
        "namespace": "documentation",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "a1916d6f-5851-4451-ab1d-ee3083f351b4",
        "creation_timestamp": "2025-11-13T23:08:55.022044Z",
        "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": {
        "simple_service": {
            "container": {
                "name": "adservice",
                "image": {
                    "name": "adservice:latest",
                    "public": {},
                    "pull_policy": "IMAGE_PULL_POLICY_DEFAULT"
                },
                "init_container": false,
                "liveness_check": null,
                "readiness_check": null,
                "command": [],
                "args": []
            },
            "configuration": null,
            "do_not_advertise": {},
            "disabled": {},
            "scale_to_zero": false
        }
    }
}
Copied!

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"adservice","namespace":"documentation"},"spec":{"simple_service":{"container":{"name":"adservice","image":{"name":"adservice:latest","public":{}}},"do_not_advertise":{},"disabled":{}}}}' -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/config/namespaces/documentation/workloads'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 1143
Content-Type: application/json
Date: Thu, 13 Nov 2025 23:08:55 GMT
Vary: Accept-Encoding
X-Volterra-Response-Fields-Deprecated: spec.service.advertise_options.advertise_custom.ports.#.http_loadbalancer.specific_routes.routes.#.direct_response_route.route_direct_response.response_body,spec.service.advertise_options.advertise_on_public.multi_ports.ports.#.http_loadbalancer.specific_routes.routes.#.direct_response_route.route_direct_response.response_body,spec.service.advertise_options.advertise_on_public.port.http_loadbalancer.specific_routes.routes.#.direct_response_route.route_direct_response.response_body,spec.stateful_service.advertise_options.advertise_custom.ports.#.http_loadbalancer.specific_routes.routes.#.direct_response_route.route_direct_response.response_body,spec.stateful_service.advertise_options.advertise_on_public.multi_ports.ports.#.http_loadbalancer.specific_routes.routes.#.direct_response_route.route_direct_response.response_body,spec.stateful_service.advertise_options.advertise_on_public.port.http_loadbalancer.specific_routes.routes.#.direct_response_route.route_direct_response.response_body

{
  "metadata": {
    "name": "adservice",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "a1916d6f-5851-4451-ab1d-ee3083f351b4",
    "creation_timestamp": "2025-11-13T23:08:55.022044Z",
    "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": {
    "simple_service": {
      "container": {
        "name": "adservice",
        "image": {
          "name": "adservice:latest",
          "public": {

          },
          "pull_policy": "IMAGE_PULL_POLICY_DEFAULT"
        },
        "init_container": false,
        "liveness_check": null,
        "readiness_check": null,
        "command": [
        ],
        "args": [
        ]
      },
      "configuration": null,
      "do_not_advertise": {

      },
      "disabled": {

      },
      "scale_to_zero": false
    }
  }
}
Copied!
On this page: