Destinations

List Destinations

get

Responses

200

OK

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/destinations

HTTPcURLJavaScriptPython

GET /v1/destinations HTTP/1.1
Host: 
Accept: */*

{
  "destinations": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "additionalInfo": {
          "documentation": [
            {
              "text": "text",
              "url": "text"
            }
          ],
          "message": "string"
        },
        "blueprintTags": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "dateModified": "text",
        "deprecated": true,
        "description": "string",
        "displayName": "string",
        "hash": "text",
        "icon": "string",
        "id": "string",
        "labels": {},
        "name": "string",
        "resourceDocLink": "string",
        "stability": "string",
        "version": 1,
        "warning": "string"
      },
      "spec": {
        "disabled": true,
        "licenseEnabled": true,
        "parameters": [
          {
            "credential": true,
            "name": "text",
            "sensitive": true,
            "value": null
          }
        ],
        "processors": [
          {
            "description": "text",
            "disabled": true,
            "displayName": "text",
            "id": "text",
            "licenseEnabled": true,
            "name": "text",
            "parameters": [
              {
                "credential": true,
                "name": "text",
                "sensitive": true,
                "value": null
              }
            ],
            "processors": "[Circular Reference]",
            "public": true,
            "recommendation": "text",
            "routes": {
              "logs": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "logs+metrics": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "logs+metrics+traces": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "logs+traces": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "metrics": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "metrics+traces": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ],
              "traces": [
                {
                  "components": [
                    "text"
                  ],
                  "id": "text"
                }
              ]
            },
            "secOpsPipelineName": "text",
            "type": "text",
            "version": "text"
          }
        ],
        "public": true,
        "recommendation": "text",
        "type": "text",
        "version": "text"
      },
      "status": {
        "latest": true
      }
    }
  ]
}

Get Destination by name

get

Path parameters

namestringRequired

the name of the Destination

Responses

200

OK

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/destinations/{name}

HTTPcURLJavaScriptPython

GET /v1/destinations/{name} HTTP/1.1
Host: 
Accept: */*

{
  "destination": {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "dateModified": "text",
      "deprecated": true,
      "description": "string",
      "displayName": "string",
      "hash": "text",
      "icon": "string",
      "id": "string",
      "labels": {},
      "name": "string",
      "resourceDocLink": "string",
      "stability": "string",
      "version": 1,
      "warning": "string"
    },
    "spec": {
      "disabled": true,
      "licenseEnabled": true,
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "processors": [
        {
          "description": "text",
          "disabled": true,
          "displayName": "text",
          "id": "text",
          "licenseEnabled": true,
          "name": "text",
          "parameters": [
            {
              "credential": true,
              "name": "text",
              "sensitive": true,
              "value": null
            }
          ],
          "processors": [
            "[Circular Reference]"
          ],
          "public": true,
          "recommendation": "text",
          "routes": {
            "logs": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "logs+metrics": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "logs+metrics+traces": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "logs+traces": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "metrics": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "metrics+traces": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ],
            "traces": [
              {
                "components": [
                  "text"
                ],
                "id": "text"
              }
            ]
          },
          "secOpsPipelineName": "text",
          "type": "text",
          "version": "text"
        }
      ],
      "public": true,
      "recommendation": "text",
      "type": "text",
      "version": "text"
    },
    "status": {
      "latest": true
    }
  }
}

Delete destination by name

delete

Path parameters

namestringRequired

the name of the destination to delete

Responses

204

Successful Delete, no content

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/destinations/{name}

HTTPcURLJavaScriptPython

DELETE /v1/destinations/{name} HTTP/1.1
Host: 
Accept: */*

No content