List clusters

GET

/v1/kubernetes/clusters

const url = 'https://api.devsecure.io/v1/kubernetes/clusters?limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.devsecure.io/v1/kubernetes/clusters?limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

ApiKey
kubernetes:read
OAuth2
kubernetes:read

Parameters

Query Parameters

limit

Limit

Page size (1-200).

integer

default: 50 >= 1 <= 200

Page size (1-200).

cursor

Any of:

string
null

string

<= 1024 characters

Opaque cursor from the previous page.

Responses

200

OK.

application/json

ClusterList

object

data

required

Data

Array<object>

Cluster

object

required

string format: uuid

name

required

Name

string

environment

Any of:

string
null

string

Allowed values: production staging development

namespace_mode

required

Namespace Mode

string

Allowed values: exclude include

namespaces

required

Namespaces

Array<string>

image_scanning

required

Image Scanning

boolean

image_tag_mode

required

Image Tag Mode

string

Allowed values: all one

connection_status

required

Connection Status

Connected: a heartbeat in the last 10 minutes and the cluster is not revoked.

string

Allowed values: connected disconnected

last_heartbeat_at

Any of:

string
null

string

agent_version

Any of:

string
null

string

kubernetes_version

Any of:

string
null

string

rule_version

Any of:

string
null

string

last_scan_status

Any of:

string
null

string

Allowed values: ok partial token_rejected rules_unavailable

revoked

required

Revoked

boolean

created_at

Any of:

string
null

string

open_findings

required

SeverityCounts

object

critical

Critical

integer

high

High

integer

medium

Medium

integer

low

Low

integer

info

Info

integer

total

Total

integer

pagination

required

PageInfo

object

next_cursor

required

Any of:

string
null

string

has_more

required

Has More

boolean

Example

{
  "data": [
    {
      "name": "prod-eu-1",
      "environment": "production",
      "namespace_mode": "exclude",
      "image_tag_mode": "all",
      "connection_status": "connected",
      "last_scan_status": "ok",
      "open_findings": {
        "critical": 0,
        "high": 0,
        "medium": 0,
        "low": 0,
        "info": 0,
        "total": 0
      }
    }
  ]
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

X-RateLimit-Limit

integer

Requests allowed per window.

X-RateLimit-Remaining

integer

Requests left in the window.

X-RateLimit-Reset

integer

Seconds until the window resets.

X-Has-Next-Page

string

Allowed values: true false

Whether another page follows.

400

The request is not valid (validation_error, invalid_cursor).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "validation_error",
    "message": "The request is not valid.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

401

Missing, unknown, expired or revoked credential (invalid_credentials).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "invalid_credentials",
    "message": "The credential is missing, invalid, expired or revoked.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

403

The credential may not do this (insufficient_scope, permission_denied, plan_not_allowed, quota_exceeded, target_not_authorized).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "insufficient_scope",
    "message": "The credential does not have the scope this operation needs.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

429

Too many requests (rate_limited).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the time in Retry-After.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

X-RateLimit-Limit

integer

Requests allowed per window.

X-RateLimit-Remaining

integer

Requests left in the window.

X-RateLimit-Reset

integer

Seconds until the window resets.

Retry-After

integer

Seconds to wait before retrying.

500

Unexpected error (internal_error). Quote the request id to support.

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.