Get a list of regions
Returns a list of regions with their details.
Authorizations:
header Parameters
X-ORG-ID | string Organization identifier passed as a header. This is optional and can normally inferred by the bearer token used for authentication. |
Responses
Response samples
- 200
- 401
[- {
- "name": "string",
- "url": "string"
}
]
Create a new organization
Creates a new organization with the provided details.
Authorizations:
Request Body schema: application/jsonrequired
display_name required | string The human readable name of the organization. |
Responses
Request samples
- Payload
{- "display_name": "string"
}
Response samples
- 201
- 400
- 401
- 500
{- "id": "string",
- "name": "string",
- "display_name": "string"
}
Get a list of members
Returns a list of members in the current organization.
Authorizations:
header Parameters
X-ORG-ID | string Organization identifier passed as a header. This is optional and can normally inferred by the bearer token used for authentication. |
Responses
Response samples
- 200
- 401
- 500
[- {
- "id": "string",
- "name": "string",
- "email": "string",
- "role": "string"
}
]
Update a member's role
Updates the role of a member in the current organization.
Authorizations:
path Parameters
id required | string The unique identifier of the member to update. |
header Parameters
X-ORG-ID | string Organization identifier passed as a header. This is optional and can normally inferred by the bearer token used for authentication. |
Request Body schema: application/jsonrequired
role | string The new role to assign to the member (e.g., admin, member, viewer). |
Responses
Request samples
- Payload
{- "role": "string"
}
Response samples
- 400
- 401
- 404
- 500
{- "message": "string"
}
Delete a member
Deletes a member from the current organization by their unique identifier.
Authorizations:
path Parameters
id required | string The unique identifier of the member to delete. |
header Parameters
X-ORG-ID | string Organization identifier passed as a header. This is optional and can normally inferred by the bearer token used for authentication. |
Responses
Response samples
- 401
- 404
- 500
{- "message": "string"
}
Invite a user to an organization
Sends an invitation to a user to join the current organization.
Authorizations:
header Parameters
X-ORG-ID | string Organization identifier passed as a header. This is optional and can normally inferred by the bearer token used for authentication. |
Request Body schema: application/jsonrequired
email required | string The email address of the user to invite. |
role | string The role to assign to the user (e.g., admin, member, viewer). |
Responses
Request samples
- Payload
{- "email": "string",
- "role": "string"
}
Response samples
- 400
- 401
- 500
{- "message": "string"
}
Get invitations for an organization
Retrieves a list of invitations for the current organization.
Authorizations:
header Parameters
X-ORG-ID | string Organization identifier passed as a header. This is optional and can normally inferred by the bearer token used for authentication. |
Responses
Response samples
- 200
- 400
- 401
- 500
[- {
- "id": "string",
- "email": "string",
- "role": "string"
}
]
Delete an invitation
Deletes an invitation by its unique identifier.
Authorizations:
path Parameters
id required | string The unique identifier of the invitation to delete. |
header Parameters
X-ORG-ID | string Organization identifier passed as a header. This is optional and can normally inferred by the bearer token used for authentication. |
Responses
Response samples
- 401
- 404
- 500
{- "message": "string"
}
Query usage data
Query usage data aggregated by project and resource.
Authorizations:
query Parameters
region required | string Region to query usage from. |
start_time required | string <date-time> Start time in RFC 3339 format. |
end_time required | string <date-time> End time in RFC 3339 format. |
header Parameters
X-ORG-ID | string Organization identifier passed as a header. This is optional and can normally inferred by the bearer token used for authentication. |
Responses
Response samples
- 200
- 400
- 401
- 404
- 500
[- {
- "project_id": "string",
- "resource": "h100-hgx-80gb",
- "value": 1440
}
]