Patch Service Interface

• Tier 0s
• Locale Services

If an interface with the interface-id is not already present, create a new interface. If it already exists, update the interface for specified attributes.

Request

URI

PATCH

https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}

COPY

Path Parameters

string

tier-0-id

Required

tier-0-id

string

locale-service-id

Required

locale-service-id

string

interface-id

Required

interface-id

---

Request Body

ServiceInterface of type(s) application/json

Optional

This request body class requires all of the following: BaseTier0Interface

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_revision": 0,
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_protection": "string",
    "_system_owned": false,
    "description": "string",
    "display_name": "string",
    "id": "string",
    "resource_type": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "parent_path": "string",
    "path": "string",
    "relative_path": "string",
    "children": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "marked_for_delete": false
        }
    ],
    "marked_for_delete": false,
    "subnets": [
        {
            "ip_addresses": [
                "string"
            ],
            "prefix_len": 0
        }
    ]
}

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Hide Details

OK

Operation doesn't return any data structure

400

Hide Details

Returns BadRequest of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

403

Hide Details

Returns Forbidden of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

404

Hide Details

Not Found

Operation doesn't return any data structure

412

Hide Details

Returns PreconditionFailed of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

500

Hide Details

Returns InternalServerError of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

503

Hide Details

Returns ServiceUnavailable of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Tier 0s Operations

PUT

Create Or Replace Tier0 Locale Services

PUT

Create Policy Service Instance

PUT

Create Service Interface

DELETE

Delete Policy Service Instance

DELETE

Delete Service Interface

DELETE

Delete Tier0 Locale Services

DELETE

Delete Tier0 Locale Services Flood Protection Profile Binding

DELETE

Delete Tier0 Locale Services Session Timer Profile Binding

GET

Get Policy Service Instance Statistics

GET

Get Tier0 Locale Services Flood Protection Profile Binding

GET

Get Tier0 Locale Services Session Timer Profile Binding

GET

List Service Interfaces

GET

List Tier0 Locale Services

PATCH

Patch Policy Service Instance

PATCH

Patch Service Interface

PATCH

Patch Tier0 Locale Services

PATCH

Patch Tier0 Locale Services Flood Protection Profile Binding Map

PATCH

Patch Tier0 Local Services Session Timer Profile Binding Map

GET

Read All Policy Service Instances For Tier0

GET

Read Policy Service Instance

GET

Read Service Interface

GET

Read Tier0 Locale Services

POST

Renew Authentication Tokens For Policy Service Instance Reauth

PUT

Update Tier0 Locale Services Flood Protection Profile Binding

PUT

Update Tier0 Locale Services Session Timer Profile Binding

GET

View Tier0 Locale Services Gateway Firewall