Update Service Profile

Modifies the specified service profile. The PUT request must include the resource_type parameters. Modifiable parameters include description and display_name. Other parameters might be modifiable, depending on the specified service type.

Request

URI

PUT

https://nsxmanager.your.domain/api/v1/service-profiles/{service-profile-id}

COPY

Path Parameters

string

service-profile-id

Required

service-profile-id

Request Body

ServiceProfile of type(s) application/json

Optional

{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "_create_user": "string",
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string"
}

SelfResourceLink

_self

Optional

_self

boolean

_system_owned

Optional

Indicates system owned resource

string

display_name

Optional

Defaults to ID if not set

string

description

Optional

description

array of Tag

tags

Optional

tags

integer As int64 As int64

_revision

Optional

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.

string

_create_user

Optional

ID of the user who created this resource

string

_schema

Optional

_schema

integer As int64 As int64

_create_time

Optional

Timestamp of resource creation

array of ResourceLink

_links

Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.

integer As int64 As int64

_last_modified_time

Optional

Timestamp of last modification

string

_last_modified_user

Optional

ID of the user who last modified this resource

string

Optional

string

resource_type

Required

Resource type of the service profile

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

200

Success

Returns ServiceProfile of type(s) application/json

{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "_create_user": "string",
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string"
}

SelfResourceLink

_self

Optional

_self

boolean

_system_owned

Optional

Indicates system owned resource

string

display_name

Optional

Defaults to ID if not set

string

description

Optional

description

array of Tag

tags

Optional

tags

integer As int64 As int64

_revision

Optional

string

_create_user

Optional

ID of the user who created this resource

string

_schema

Optional

_schema

integer As int64 As int64

_create_time

Optional

Timestamp of resource creation

array of ResourceLink

_links

Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.

integer As int64 As int64

_last_modified_time

Optional

Timestamp of last modification

string

_last_modified_user

Optional

ID of the user who last modified this resource

string

Optional

string

resource_type

Required

Resource type of the service profile

default

Unexpected error

Returns ApiError of type(s) application/json

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

string

module_name

Optional

module_name

string

error_message

Optional

error_message

integer As int64 As int64

error_code

Optional

error_code

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Logical Routing And Services Operations

Create Dhcp Relay Profile

POST

Create Logical Router

POST

Create Logical Router Port

POST

Create Service

POST

Create Service Profile

POST

Create Static Hop Bfd Peer

Delete Dhcp Relay Profile

DELETE

Delete IP Prefix List

DELETE

Delete Logical Router

DELETE

Delete Logical Router Port

Delete Service Profile