Services Config Propagation

Services Config Propagation
Propagates external services connection configs to provided components

Propagates external services connection configs to provided components

Request
URI
POST
https://{api_host}/v1/services-config/propagation
COPY
Request Body
ServicesConfigPropagationInput of type(s) application/json
Required

Show optional properties

{
    "vcenterIds": [
        {}
    ]
}
{
    "vcenterIds": [
        "string"
    ]
}
array of string
vcenterIds
Required

vcenterIds

Responses
202

Accepted

Returns ServicesConfigPropagationTask of type(s) application/json 
{
    "taskId": "string",
    "description": "string",
    "status": "One among: IN_PROGRESS, SUCCEEDED, FAILED",
    "errorResponse": {
        "errorCode": "string",
        "errorType": "string",
        "arguments": [
            "string"
        ],
        "context": {
            "context": "string"
        },
        "notifications": [
            {
                "severity": "string",
                "message": "string",
                "remediations": [
                    {
                        "message": "string",
                        "link": "string"
                    }
                ],
                "impactMessage": "string"
            }
        ],
        "message": "string",
        "remediationMessage": "string",
        "causes": [
            {
                "type": "string",
                "message": "string"
            }
        ],
        "nestedErrors": [
            {
                "errorCode": "string",
                "errorType": "string",
                "arguments": [
                    "string"
                ],
                "context": {
                    "context": "string"
                },
                "notifications": [
                    {
                        "severity": "string",
                        "message": "string",
                        "remediations": [
                            {
                                "message": "string",
                                "link": "string"
                            }
                        ],
                        "impactMessage": "string"
                    }
                ],
                "message": "string",
                "remediationMessage": "string",
                "causes": [
                    {
                        "type": "string",
                        "message": "string"
                    }
                ],
                "nestedErrors": [
                    {
                        "errorCode": "string",
                        "errorType": "string",
                        "arguments": [
                            "string"
                        ],
                        "context": {
                            "context": "string"
                        },
                        "notifications": [
                            {
                                "severity": "string",
                                "message": "string",
                                "remediations": [
                                    {
                                        "message": "string",
                                        "link": "string"
                                    }
                                ],
                                "impactMessage": "string"
                            }
                        ],
                        "message": "string",
                        "remediationMessage": "string",
                        "causes": [
                            {
                                "type": "string",
                                "message": "string"
                            }
                        ],
                        "nestedErrors": [
                            "Error Object"
                        ],
                        "referenceToken": "string",
                        "label": "string",
                        "remediationUrl": "string"
                    }
                ],
                "referenceToken": "string",
                "label": "string",
                "remediationUrl": "string"
            }
        ],
        "referenceToken": "string",
        "label": "string",
        "remediationUrl": "string"
    }
}
string
taskId
Required

ID of the services config propagation task

string
description
Required

Description of the services config propagation operation

string
status
Required

Status of the services config propagation task

object
errorResponse
Optional

Error response containing a minor error code, a localized error message, a localized remediation message and optionally a reference token to correlate the error with the logs


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).

array of object
notifications
Optional

Detailed results of the precheck validation.

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

Internal Server Error

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).

array of object
notifications
Optional

Detailed results of the precheck validation.

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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"vcenterIds":["string"]}' https://{api_host}/v1/services-config/propagation
On This Page
Services Config Operations
GET
Get Services Config
PUT
Update Services Config
POST
Services Config Propagation
GET
Get Service Config By Key
DELETE
Delete Service Config By Key
GET
Get Services Config Propagation Task