ClusterService

Delete deletes a cluster

DELETE

https://argocd.example.com/api/v1/clusters/{id.value}

curl -X DELETE 'https://argocd.example.com/api/v1/clusters/string' \
  -H 'Authorization: YOUR_TOKEN'

const response = await fetch('https://argocd.example.com/api/v1/clusters/string', {
  method: 'DELETE',
  headers: {
    'Authorization': 'YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://argocd.example.com/api/v1/clusters/string',
    headers={
        'Authorization': 'YOUR_TOKEN',
    },
)
print(response.text)

{}

{
  "code": 0,
  "details": [
    {
      "type_url": "string",
      "value": "dGVzdA=="
    }
  ],
  "error": "string",
  "message": "string"
}

Parameters

id.valuestringrequiredpath

value holds the cluster server URL or cluster name

serverstringquery

namestringquery

id.typestringquery

type is the type of the specified cluster identifier ( "server" - default, "name" ).

Response

200OKclusterClusterResponse

A successful response.

Response fields application/json

clusterClusterResponse

defaultruntimeError

An unexpected error response.

Response fields application/json

codeinteger<int32>

detailsArray<protobufAny>

Show child attributes

type_urlstring

valuestring<byte>

errorstring

messagestring

Authorization

bearerapiKey in header

A token sent as Authorization: Bearer <token>. API Docs shows how to get one.

Docs by Sourcey