gateway.openapi_Gateway

Update Cluster

patch/v1/accounts/{account_id}/clusters/{cluster_id}

Request

  • Base URL: https://api.fireworks.ai
  • URL: https://api.fireworks.ai/v1/accounts/{account_id}/clusters/{cluster_id}
  • Auth: HTTP bearer

Path parameters

account_idstring required

The Account Id

cluster_idstring required

The Cluster Id

Request body

displayNamestring

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

createTimestring date-time

The creation time of the cluster.

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'DELETING' | 'FAILED'
  • CREATING: The cluster is still being created.
  • READY: The cluster is ready to be used.
  • DELETING: The cluster is being deleted.
  • FAILED: Cluster is not operational. Consult 'status' for detailed messaging. Cluster needs to be deleted and re-created.
updateTimestring date-time

The update time for the cluster.

Response

A successful response.

namestring
displayNamestring

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

createTimestring date-time

The creation time of the cluster.

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'DELETING' | 'FAILED'
  • CREATING: The cluster is still being created.
  • READY: The cluster is ready to be used.
  • DELETING: The cluster is being deleted.
  • FAILED: Cluster is not operational. Consult 'status' for detailed messaging. Cluster needs to be deleted and re-created.
updateTimestring date-time

The update time for the cluster.

Changes

No recorded changes to this operation across all 1 revision of this API.