Get Configuration

Get Configuration

Retrieves the definition of a configuration. The returned definition contains base data for the configuration. When a request is sent to this endpoint with "application/vcoobject+xml" as the desired response content type, this operation is the equivalent of "Export configuration": Exports a configuration by its ID. If the request is successful, the configuration binary content is available in the body of the response message. It is up to the client application to properly fetch and process this attachment, for example, by saving it to the local file system. The exported configuration has the same internal format as the configurations exported by using the VCF Operations Orchestrator client.

Request
URI
GET
https://{api_host}/vco/api/configurations/{id}
COPY
Path Parameters
string
id
Required

id


Authentication
This operation uses the following authentication methods.
Responses
200

The request is successful

Returns WsConfiguration of type(s) application/json
{
    "relations": {
        "startIndex": 0,
        "count": 0,
        "total": 0,
        "link": [
            {
                "rel": "string",
                "type": "string",
                "attributes": [
                    {
                        "name": "string",
                        "displayName": "string",
                        "value": "string",
                        "displayValue": "string"
                    }
                ],
                "href": "string"
            }
        ]
    },
    "id": "string",
    "name": "string",
    "description": "string",
    "version": "string",
    "status": 0,
    "attributes": [
        {
            "name": "string",
            "type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
            "description": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "href": "string",
    "category-id": "string"
}
object
relations
Optional

relations

string
id
Optional

id

string
name
Optional

name

string
description
Optional

description

string
version
Optional

version

integer As int32 As int32
status
Optional

status

array of object
attributes
Optional

attributes

string
href
Optional

href

string
category-id
Optional

category-id


401

User is not authorized

Returns WsConfiguration of type(s) application/json
"WsConfiguration Object"
object
relations
Optional

relations

string
id
Optional

id

string
name
Optional

name

string
description
Optional

description

string
version
Optional

version

integer As int32 As int32
status
Optional

status

array of object
attributes
Optional

attributes

string
href
Optional

href

string
category-id
Optional

category-id


404

Cannot find configuration with the specified ID

Returns WsConfiguration of type(s) application/json
"WsConfiguration Object"
object
relations
Optional

relations

string
id
Optional

id

string
name
Optional

name

string
description
Optional

description

string
version
Optional

version

integer As int32 As int32
status
Optional

status

array of object
attributes
Optional

attributes

string
href
Optional

href

string
category-id
Optional

category-id


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vco/api/configurations/{id}