PATCH
/
v1
/
accounts
/
{account_id}
/
clusters
/
{cluster_id}
curl --request PATCH \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/clusters/{cluster_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "displayName": "<string>",
  "eksCluster": {
    "awsAccountId": "<string>",
    "fireworksManagerRole": "<string>",
    "region": "<string>",
    "clusterName": "<string>",
    "storageBucketName": "<string>",
    "metricWriterRole": "<string>",
    "loadBalancerControllerRole": "<string>",
    "workloadIdentityPoolProviderId": "<string>",
    "inferenceRole": "<string>"
  },
  "fakeCluster": {
    "projectId": "<string>",
    "location": "<string>",
    "clusterName": "<string>"
  }
}'
{
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "eksCluster": {
    "awsAccountId": "<string>",
    "fireworksManagerRole": "<string>",
    "region": "<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 header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
account_id
string
required

The Account Id

​
cluster_id
string
required

The Cluster Id

Body

application/json
The properties of the cluster being updated. `cluster.name` must be populated with the updated resource's name.
​
displayName
string

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

​
eksCluster
object
​
fakeCluster
object
​
state
enum<string>
default:STATE_UNSPECIFIED

The current state of the cluster.

Available options:
STATE_UNSPECIFIED,
CREATING,
READY,
DELETING,
FAILED
​
status
object

Detailed information about the current status of the cluster.

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

The creation time of the cluster.

​
eksCluster
object
​
fakeCluster
object
​
state
enum<string>
default:STATE_UNSPECIFIED

The current state of the cluster.

Available options:
STATE_UNSPECIFIED,
CREATING,
READY,
DELETING,
FAILED
​
status
object

Detailed information about the current status of the cluster.

​
updateTime
string

The update time for the cluster.

Was this page helpful?

Suggest edits