Update Global Settings

Update Global Settings

This API is to be used for updating the global settings.

Request
URI
PUT
https://{api_host}/hybridity/api/ztp/v1/globalsettings
COPY
Request Body

The request payload for Update Global Settings API.

InlineZtpV1GlobalsettingsRequestBody of type(s) application/json
Required 
{
    "id": "string",
    "version": 0,
    "dns": {
        "suffix": "string",
        "servers": [
            "string"
        ]
    },
    "ntp": {
        "servers": [
            "string"
        ]
    },
    "csiTagging": {
        "enableCsiZoning": false,
        "clusterCsiZoneTagNamingScheme": "string",
        "hostCsiZoneTagNamingScheme": "string"
    },
    "tcaSsoCredentials": {
        "username": "[email protected]",
        "password": "string"
    }
}
string As uuid As uuid
id
Optional

The unique ID of the global settings. This is optional when creating global settings and required when updating global settings(s) in the absence of global settings ID as API Path Param. This field cannot be updated when updating global settings.

integer
version
Optional

The version of this global settings entity. This field must be specified during global settings Update.

object
dns
Required

DNS Server details.

object
ntp
Required

NTP Server details.

object
csiTagging
Optional

CSI Tagging data.

object
tcaSsoCredentials
Required

TCA SSO credentials.

Authentication
This operation uses the following authentication methods.
Responses
200

The submitted global settings have been updated successfully.

Returns InlineZtpV1Globalsettings200Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


301

API endpoint has permanently moved.

Returns InlineZtpV1Globalsettings301Response of type(s) application/json 
{
    "redirectURL": "string"
}
string
redirectURL
Optional

redirectURL

Response Headers

string
Location

URI where the client will find the new endpoint.


400

Response may include details of why the request is bad.

Returns InlineZtpV1Globalsettings400Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


401

User is not authenticated to invoke this endpoint.

Operation doesn't return any data structure

403

User is not authorized to invoke this endpoint.

Operation doesn't return any data structure

422

The request payload couldn't be processed by the server.

Returns InlineZtpV1Globalsettings422Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


500

An internal server error has occurred.

Returns InlineZtpV1Globalsettings500Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


On This Page
Global Settings Operations
GET
Get Global Settings
PUT
Update Global Settings