Vcenter NamespaceManagement SupervisorServices create

Vcenter NamespaceManagement SupervisorServices create

Create a Supervisor Service. If version specs are provided in the spec, new Supervisor Service versions will be created as part of the operation.

This operation was added in vSphere API 7.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires SupervisorServices.Manage.
Request
URI
POST
https://{api_host}/api/vcenter/namespace-management/supervisor-services
COPY
Request Body

Specification for the Supervisor Service with version definition.

{
    "custom_spec": {
        "supervisor_service": "string",
        "display_name": "string",
        "description": "string",
        "version_spec": {
            "version": "string",
            "display_name": "string",
            "description": "string",
            "content": "string",
            "trusted_provider": false
        }
    },
    "vsphere_spec": {
        "version_spec": {
            "content": "string",
            "trusted_provider": false,
            "accept_eula": false
        }
    },
    "carvel_spec": {
        "version_spec": {
            "content": "string"
        }
    }
}
custom_spec
Optional

The specification required to create a Supervisor Service with a version from inline content that is based on a plain Kubernetes YAML format.

This property was added in vSphere API 7.0.3.0.

If set, the service will be created from a version based on a plain Kubernetes YAML format.

vsphere_spec
Optional

The specification required to create a Supervisor Service with a version from inline content that is based on the vSphere application service format.

This property was added in vSphere API 7.0.3.0.

If set, the service will be created from a version based on the vSphere application service format.

carvel_spec
Optional

The specification required to create a Supervisor Service with a version from inline content that is based on the Carvel application package format.

This property was added in vSphere API 8.0.0.1.

If set, the service will be created from a version based on the Carvel application package format (Package and PackageMetadata resources should be declared).

Authentication
This operation uses the following authentication methods.
Responses
201

Success!

Operation doesn't return any data structure

400

Vapi Std Errors AlreadyExists if a Supervisor Service with the same identifier already exists.

Vapi Std Errors InvalidArgument if spec contain any errors or if an invalid name is specified. For example, when the service is from a trusted provider, but no signature is provided or it is invalid.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user doesn't have the SupervisorServices.Manage privilege.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0
"Vapi Std Errors Unauthorized Object"

500

if the system reports an error while responding to the request.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/namespace-management/supervisor-services