Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
clusters
/
{cluster_id}
Get Cluster
curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/clusters/{cluster_id} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "eksCluster": {
    "awsAccountId": "<string>",
    "region": "<string>",
    "fireworksManagerRole": "<string>",
    "clusterName": "<string>",
    "storageBucketName": "<string>",
    "metricWriterRole": "<string>",
    "loadBalancerControllerRole": "<string>",
    "workloadIdentityPoolProviderId": "<string>",
    "inferenceRole": "<string>"
  },
  "fakeCluster": {
    "projectId": "<string>",
    "location": "<string>",
    "clusterName": "<string>"
  },
  "state": "STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

​
account_id
string
required

The Account Id

​
cluster_id
string
required

The Cluster Id

Query Parameters

​
readMask
string

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

200 - application/json

A successful response.

​
name
string
​
displayName
string

Human-readable display name of the cluster. e.g. "My Cluster" Must be fewer than 64 characters long.

​
createTime
string<date-time>

The creation time of the cluster.

​
eksCluster
An Amazon Elastic Kubernetes Service cluster. Next ID: 16 · object
​
fakeCluster
A fake cluster using https://pkg.go.dev/k8s.io/client-go/kubernetes/fake · object
​
state
enum<string>
default:STATE_UNSPECIFIED

The current state of the cluster.

Available options:
STATE_UNSPECIFIED,
CREATING,
READY,
DELETING,
FAILED
​
status
Mimics [https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto] · object

Detailed information about the current status of the cluster.

​
updateTime
string<date-time>

The update time for the cluster.