Get Global Settings

Get Global Settings

This API fetches the global settings.

Request
URI
GET
https://{api_host}/hybridity/api/ztp/v1/globalsettings
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Response that includes the global settings.

Returns InlineZtpV1Globalsettings200Response of type(s) application/json 
{
    "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"
    },
    "createdTimestamp": 0,
    "lastUpdatedTimestamp": 0
}
string
id
Optional

The unique ID of the global settings.

integer
version
Optional

The version of this global settings entity.

object
dns
Optional

DNS Server details.

object
ntp
Optional

NTP Server details.

object
csiTagging
Optional

CSI Tagging data.

object
tcaSsoCredentials
Optional

TCA sso credentials.

integer As int64 As int64
createdTimestamp
Optional

The timestamp of when the global settings were first saved.

integer As int64 As int64
lastUpdatedTimestamp
Optional

The timestamp of when the global settings were last modified.


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.


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

404

Global Settings were not found.

Operation doesn't return any data structure

422

The request parameters 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