Collector Group Operation Using POST

Collector Group Operation Using POST

Operations on vROps Collector Groups

Request
URI
POST
https://{api_host}/lcm/lcops/api/v2/environments/{environmentId}/products/{productId}/collectorgroups
COPY
Path Parameters
string
environmentId
Required

environmentId

string
productId
Required

productId


Request Body

collectorGroupDTO

CollectorGroupDTO of type(s) application/json
Required
{
    "collectorGroups": [
        {
            "description": "string",
            "id": "d7d5624a-f975-48c0-864b-868ca883d979",
            "name": "test collector group",
            "nodes": [
                {
                    "type": "vrava-primary"
                }
            ]
        }
    ],
    "collectorsName": [
        "string"
    ],
    "operationType": "add"
}
collectorGroups
Optional

collectorGroups

array of string
collectorsName
Optional

collectorsName

string
operationType
Optional

operation type

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Array of GenericRequestResponse of type(s) application/json
[
    {
        "requestId": "a0d8d8cd-ac87-4b5c-ba8b-7a0173c56b55"
    }
]

201

Created

Operation doesn't return any data structure

400

Bad Request

Returns GenericErrorResponseDTO of type(s) application/json
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Returns GenericErrorResponseDTO of type(s) application/json
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations