Get Domain Capabilities

Get Domain Capabilities

Get the capabilities of all domains

Request
URI
GET
https://{api_host}/v1/domains/capabilities
COPY
Query Parameters
string of array
capabilities
Optional

Capabilities separated by comma. Filters DomainCapabilities where each domain has all given capabilities


Responses
200

Ok

Returns DomainsWithCapabilities of type(s) application/json
{
    "result": {
        "elements": [
            {
                "domainId": "string",
                "capabilities": [
                    "List can contain values among: REPOSITORY_IMAGES, BASELINE_CLUSTERS_UPGRADE, HETEROGENEOUS_CLUSTER"
                ]
            }
        ],
        "pageMetadata": {
            "pageNumber": 0,
            "pageSize": 0,
            "totalElements": 0,
            "totalPages": 0
        }
    },
    "errors": [
        {
            "error": {
                "errorCode": "string",
                "errorType": "string",
                "arguments": [
                    "string"
                ],
                "context": {
                    "context": "string"
                },
                "message": "string",
                "remediationMessage": "string",
                "causes": [
                    {
                        "type": "string",
                        "message": "string"
                    }
                ],
                "nestedErrors": [
                    "Error Object"
                ],
                "referenceToken": "string",
                "label": "string",
                "remediationUrl": "string"
            },
            "resource": {
                "id": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
                "type": "One among: DOMAIN, VCENTER, CLUSTER, HOST",
                "name": "string"
            }
        }
    ]
}
object
result
Optional

Represents a page of elements of a single type

array of object
errors
Optional

Errors associated to domains, for which capabilities retrieval failed


400

Bad Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


500

InternalServerError

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/domains/capabilities