Create Cluster
curl --request POST \
--url https://api.fireworks.ai/v1/accounts/{account_id}/clusters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"cluster": {
"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>"
}
},
"clusterId": "<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>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The Account Id
Body
The properties of the cluster being created.
Human-readable display name of the cluster. e.g. "My Cluster" Must be fewer than 64 characters long.
The 12-digit AWS account ID where this cluster lives.
The AWS region where this cluster lives. See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html for a list of available regions.
The EKS cluster name.
The S3 bucket name.
The IAM role ARN used by Google Managed Prometheus role that will write metrics
to Fireworks managed Prometheus. The role must be assumable by the
system:serviceaccount:gmp-system:collector service account on the EKS cluster.
If not specified, no metrics will be written to GCP.
The IAM role ARN used by the EKS load balancer controller (i.e. the load balancer automatically created for the k8s gateway resource). If not specified, no gateway will be created.
The IAM role ARN used by the inference pods on the cluster.
The current state of the cluster.
STATE_UNSPECIFIED, CREATING, READY, DELETING, FAILED Detailed information about the current status of the cluster.
The status code.
OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, DATA_LOSS A developer-facing error message in English.
Response
Human-readable display name of the cluster. e.g. "My Cluster" Must be fewer than 64 characters long.
The creation time of the cluster.
The 12-digit AWS account ID where this cluster lives.
The AWS region where this cluster lives. See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html for a list of available regions.
The EKS cluster name.
The S3 bucket name.
The IAM role ARN used by Google Managed Prometheus role that will write metrics
to Fireworks managed Prometheus. The role must be assumable by the
system:serviceaccount:gmp-system:collector service account on the EKS cluster.
If not specified, no metrics will be written to GCP.
The IAM role ARN used by the EKS load balancer controller (i.e. the load balancer automatically created for the k8s gateway resource). If not specified, no gateway will be created.
The IAM role ARN used by the inference pods on the cluster.
The current state of the cluster.
STATE_UNSPECIFIED, CREATING, READY, DELETING, FAILED Detailed information about the current status of the cluster.
The status code.
OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, DATA_LOSS A developer-facing error message in English.
Was this page helpful?
curl --request POST \
--url https://api.fireworks.ai/v1/accounts/{account_id}/clusters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"cluster": {
"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>"
}
},
"clusterId": "<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>"
}
}