Get Domains Metadata

Get Domains Metadata

This API fetches the metadata for the different domain types supported.

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

Response that includes the metadata for the different domain types supported.

Returns InlineZtpV1DomainsMetadata200Response of type(s) application/json
{
    "domainTypes": [
        {
            "type": "string",
            "prettyName": "string",
            "count": 0
        }
    ]
}
array of object
domainTypes
Optional

A list of objects denoting different types of domains.


301

API endpoint has permanently moved.

Returns InlineZtpV1DomainsMetadata301Response 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

The specified domain was not found.

Operation doesn't return any data structure

422

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

Returns InlineZtpV1DomainsMetadata422Response 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 InlineZtpV1DomainsMetadata500Response 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.