Get Services Config
Retrieve the external services connection configurations.
Get the external services connection configurations. In a fresh setup, this would be empty.
Request
URI
GET
https://{api_host}/v1/services-config
COPY
Responses
200
OK
Returns
ServicesConfig
of type(s)
application/json
{
"services": [
{
"name": "string",
"type": "One among: VCF_DEPOT",
"key": "string",
"version": "string",
"nodes": [
{
"name": "string",
"addresses": [
{
"type": "One among: fqdn, ipv4, ipv6",
"value": "string"
}
],
"port": "string",
"baseUrl": "string",
"certificates": [
"string"
]
}
]
}
]
}
array of
object
services
Required
Constraints:
minItems: 1
External services configurations
500
Internal Server Error
Returns
Error
of type(s)
application/json
{
"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"
}
string
errorCode
Read-Only
The minor error code
string
errorType
Read-Only
The error type
array of
string
arguments
Read-Only
The arguments used to localize the message, Can be used by scripts to automate the error processing.
object
context
Read-Only
The error context (e.g. the component where it occurred).
array of
object
notifications
Read-Only
Detailed results of the precheck validation.
string
message
Read-Only
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of
object
causes
Optional
The underlying cause exceptions.
array of
object
nestedErrors
Optional
The nested errors when the error is a composite one
string
referenceToken
Read-Only
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
label
Read-Only
The localized label message
string
remediationUrl
Read-Only
The URL string for remediation documentation link
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v1/services-config