Edge Infrastructure Manager API#

The Edge Infrastructure Manager REST API provide endpoints for the full life cycle management of edge infrastructure. These APIs offer Create, Read, Update, Delete capabilities for all the Edge Infrastructure Manager elements: sites, regions, hosts, OS profiles and Resources, workloads, instances, provides, Telemetry configuration, Maintenance Schedules and more.

The APIs return error codes based on the internal result of the operation.

Edge Infrastructure Manager REST API are secured via certificates and credentials.

Note

Resources that are depended on by other resources cannot be deleted unless the referring object is deleted first - a few examples:

  • A Host that has an Instance that Workloads, which are used by Cluster Orchestrator to refer clusters (and thus application orchestrator deployments) on it cannot be deleted.

  • A Site or Region that contains a Host on cannot be deleted.

  • An Instance with an associated Cluster Member cannot be deleted.

Furthermore some DELETE operations are not immediate due to working with physical hardware, requiring reconciliation cycles.

Download the Edge Infrastructure Manager API in OpenAPI YAML format

GET /v1/projects/{projectName}/compute#

Gets a compute object

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details. Takes precedence over other filter parameters, if set.

  • orderBy (string) – Optional comma separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

  • siteID (string) – Returns only the compute elements that are assigned with the given site ID. If equals to ‘null’, then it returns all the hosts not associated with any site.

  • instanceID (string) – Returns only the compute elements that are assigned to the given instanceID. If equals to ‘null’, then it returns all the hosts not associated with any instance.

  • uuid (string) – Returns the compute elements associated with the given UUID. UUID field cannot be null, if specified needs to be filled.

  • metadata (array) – Filters the metadata associated with the compute element. Values are expected to be in the form of ‘key=value’.

  • detail (boolean) – Indicates if compute elements identified by the filter need to be returned with all their respective child resources, e.g., USBs, Interfaces, Storages.

Status Codes:

  • 200 OK – A compute object

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/compute/hosts#

Gets all host objects

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details. Takes precedence over other filter parameters, if set.

  • orderBy (string) – Optional comma separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

  • siteID (string) – Returns only the hosts that are assigned with the given site ID. If equals to ‘null’, then it returns all the hosts not associated with any site.

  • instanceID (string) – Returns only the hosts that are assigned to the given instanceID. If equals to ‘null’, then it returns all the hosts not associated with any instance.

  • uuid (string) – Returns the host associated with the given UUID. UUID field cannot be null, if specified needs to be filled.

  • metadata (array) – Filters the metadata associated with the Host. Values are expected to be in the form ‘key=value’.

  • detail (boolean) – Indicates if the host identified by the filter needs to be returned with all their respective child resources, e.g., USBs, interfaces, and storages.

Status Codes:

  • 200 OK – Array of all host objects

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/compute/hosts#

Creates a compute host.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the created host.

DELETE /v1/projects/{projectName}/compute/hosts/{hostID}#

Deletes a host.

Parameters:

  • hostID (string) – The unique host identifier

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/compute/hosts/{hostID}#

Queries a host through the host ID.

Parameters:

  • hostID (string) – The unique host identifier

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The requested instance based on it’s ID

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/compute/hosts/{hostID}#

Partially updates a host.

Parameters:

  • hostID (string) – The unique host identifier

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The host was patched.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PUT /v1/projects/{projectName}/compute/hosts/{hostID}#

Updates a host.

Parameters:

  • hostID (string) – The unique host identifier

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The host was updated

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PUT /v1/projects/{projectName}/compute/hosts/{hostID}/invalidate#

Invalidates a host by marking it as untrusted. Once invalidated, a Host will no longer be able to communicate with Edge Infrastructure Manager unless it is deleted and provisioned again.

Parameters:

  • hostID (string) – The unique host identifier

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The host was invalidated

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/compute/hosts/{hostID}/onboard#

Onboards a host to Edge Orchestrator.

Parameters:

  • hostID (string) – The unique host identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The host was onboarded.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/compute/hosts/{hostID}/register#

Updates a host registration information.

Parameters:

  • hostID (string) – The unique host identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The host registration information was updated.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/compute/hosts/register#

Registers a host by providing unique identifiers.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the registered host.

GET /v1/projects/{projectName}/compute/hosts/summary#

Gets the summary of host objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • siteID (string) – The site ID the hosts belong to. If not specified, returns the summary of all hosts. If specified, returns the summary of hosts that have the given site ID applied to them.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details. Takes precedence over other filter parameters, if set.

Status Codes:

  • 200 OK – A summary of host objects associated with the given site ID.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/compute/instances#

Gets all instance objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

  • workloadMemberID (string) – Returns only the instances that are assigned to the given workload member. If equals to ‘null’, returns all instances not associated with any workload member. If equal to ‘’ (empty string), returns all instances that have a workload member associated.

  • hostID (string) – Returns the instances associated with the host with the given host ID.

  • siteID (string) – Returns the instances associated with the hosts in the site identified. by the given siteID

Status Codes:

  • 200 OK – Array of all instance objects.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/compute/instances#

Creates an instance.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the created instance.

DELETE /v1/projects/{projectName}/compute/instances/{instanceID}#

Deletes an instance, provided that the instance does not contain members.

Parameters:

  • instanceID (string) – The unique instance identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/compute/instances/{instanceID}#

Gets an instance.

Parameters:

  • instanceID (string) – The unique instance identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The requested instance based on its ID.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/compute/instances/{instanceID}#

Partially updates an instance.

Parameters:

  • instanceID (string) – The unique instance identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The instance was patched.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PUT /v1/projects/{projectName}/compute/instances/{instanceID}/invalidate#

Invalidates an instance by marking it as untrusted. Once invalidated, the instance will no longer be able to communicate with Edge Infrastructure Manager unless it is deleted and provisioned again.

Parameters:

  • instanceID (string) – The unique instance identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The instance was invalidated

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/compute/os#

Gets all OS resources’ objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details. Takes precedence over other filter parameters, if set.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

Status Codes:

  • 200 OK – Array of all OS resource objects.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/compute/os#

Creates an OS resource.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the created OS resource.

DELETE /v1/projects/{projectName}/compute/os/{OSResourceID}#

Deletes an OS resource.

Parameters:

  • OSResourceID (string) – The unique OS resource identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/compute/os/{OSResourceID}#

Gets an OS resource.

Parameters:

  • OSResourceID (string) – The unique OS resource identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The requested OS resource.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/compute/os/{OSResourceID}#

Partially updates an OS resource.

Parameters:

  • OSResourceID (string) – The unique OS resource identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The OS resource was patched.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PUT /v1/projects/{projectName}/compute/os/{OSResourceID}#

Updates an OS resource.

Parameters:

  • OSResourceID (string) – The unique OS resource identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The OS resource was updated.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/compute/schedules#

Gets all schedules to operate on objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Identifies the paging unique identifier for a single page, starts index at 1.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • regionID (string) – The region ID target of the schedules. If not specified, returns all schedules (given the other query parameters). If specified, returns the schedules that have the specified region ID applied to them, i.e., target including the inherited ones (parent region if not null). If null, returns all schedules without a region ID as target.

  • siteID (string) – The site ID target of the schedules. If not specified, returns all schedules (given the other query parameters). If specified, returns the schedules that have the specified site ID applied to them, i.e., target including the inherited ones. If null, returns all schedules without a site ID as target.

  • hostID (string) – The host ID target of the schedules. If not specified, returns all schedules (given the other query parameters). If specified, returns the schedules that have the specified host ID applied to them, i.e., target including the inherited ones (parent site if not null). If null, returns all schedules without a host ID as target.

  • unix_epoch (string) – Filters based on the timestamp, expected to be UNIX epoch UTC timestamp in seconds

Status Codes:

  • 200 OK – Arrays of all schedule objects.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/compute/workloads#

Gets all workload objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details. Takes precedence over other filter parameters, if set.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

  • kind (string)

Status Codes:

  • 200 OK – Array of all workload objects.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/compute/workloads#

Creates a workload object.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the workload created.

DELETE /v1/projects/{projectName}/compute/workloads/{workloadID}#

Deletes a workload, provided that the workload does not contain members.

Parameters:

  • workloadID (string) – The unique workload identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/compute/workloads/{workloadID}#

Gets a workload object.

Parameters:

  • workloadID (string) – The unique workload identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The requested workload object given its ID.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/compute/workloads/{workloadID}#

Partially updates a workload object.

Parameters:

  • workloadID (string) – The unique workload identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The workload was patched.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PUT /v1/projects/{projectName}/compute/workloads/{workloadID}#

Updates a workload object.

Parameters:

  • workloadID (string) – The unique workload identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The workload was updated.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/compute/workloads/{workloadID}/members#

Gets the list of workload members.

Parameters:

  • projectName (string) – unique projectName for the resource

  • workloadID (string) – unique workloadID for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details. Takes precedence over other filter parameters, if set.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

  • workload_id (string) – The unique workload identifier.

Status Codes:

  • 200 OK – The requested workload members.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/compute/workloads/{workloadID}/members#

Adds a workload member object.

Parameters:

  • projectName (string) – unique projectName for the resource

  • workloadID (string) – unique workloadID for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the workload member created.

DELETE /v1/projects/{projectName}/compute/workloads/{workloadID}/members/{workloadMemberID}#

Removes the workload member.

Parameters:

  • workloadMemberID (string) – The unique identifier of the workload member.

  • projectName (string) – unique projectName for the resource

  • workloadID (string) – unique workloadID for the resource

Status Codes:
GET /v1/projects/{projectName}/compute/workloads/{workloadID}/members/{workloadMemberID}#

Gets the workload member based on its given ID.

Parameters:

  • workloadMemberID (string) – The unique identifier of the workload member.

  • projectName (string) – unique projectName for the resource

  • workloadID (string) – unique workloadID for the resource

Status Codes:

  • 200 OK – The requested workload member.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/localAccounts#

Gets all local account objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

Status Codes:

  • 200 OK – Array of all local account objects.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/localAccounts#

Create a Local account instance

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the created Local account resource.

DELETE /v1/projects/{projectName}/localAccounts/{localAccountID}#

Delete a local account object by ID.

Parameters:

  • localAccountID (string) – The unique identifier of the local account.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/localAccounts/{localAccountID}#

Get a local account object by ID.

Parameters:

  • localAccountID (string) – The unique identifier of the local account.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – Local account object.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/locations#

Gets a list of location node objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • name (string) – The name of the resource to be queried; it can be a region and/or site name, if the query parameters below are stated.

  • showSites (boolean) – Indicates if the filter will be applied on the site resources.

  • showRegions (boolean) – Indicates if the filter will be applied on the region resources.

Status Codes:

  • 200 OK – Array of the location node objects containing the resources that match the query name parameter. For each type of location, the maximum amount of resources to be returned is 20.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/providers#

Gets all provider objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details. Takes precedence over other filter parameters, if set.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

Status Codes:

  • 200 OK – Array of all provider objects.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/providers#

Creates a provider resource.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the created provider resource.

DELETE /v1/projects/{projectName}/providers/{providerID}#

Deletes a provider resource.

Parameters:

  • providerID (string) – The provider resource’s unique identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/providers/{providerID}#

Gets a provider resource.

Parameters:

  • providerID (string) – The provider resource’s unique identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The requested provider resource.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/regions#

Gets all region objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

  • parent (string) – The parent region ID that the region belongs to. If not specified, returns all regions. If specified, returns the regions that have the specified parent applied to them. If null, returns all the regions without a parent.

  • showTotalSites (boolean) – Indicates if the region identified by the filter needs to be returned with the field totalSites filled.

Status Codes:

  • 200 OK – Array of all region objects.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/regions#

Creates a region.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 201 Created – The region was created.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

Response Headers:

  • Location – Contains the URI of the created region.

DELETE /v1/projects/{projectName}/regions/{regionID}#

Deletes a region.

Parameters:

  • regionID (string) – The unique region identifier

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 204 No Content – The region was deleted.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/regions/{regionID}#

Gets a region.

Parameters:

  • regionID (string) – The unique region identifier

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The requested region.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

PATCH /v1/projects/{projectName}/regions/{regionID}#

Partially updates a region.

Parameters:

  • regionID (string) – The unique region identifier

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The region was patched.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

PUT /v1/projects/{projectName}/regions/{regionID}#

Updates a region.

Parameters:

  • regionID (string) – The unique region identifier

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The region was updated.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

GET /v1/projects/{projectName}/regions/{regionID}/sites#

Gets all site objects.

Parameters:

  • regionID (string) – The region ID that the sites belong to. If not specified, returns all sites (given the other query params). If specified, returns the sites that have the specified region ID applied to them. If null, returns all sites without a region ID.

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • filter (string) – Optional filter to return only items of interest. See https://google.aip.dev/160 for details.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

  • ouID (string) – The OUID that the sites belong to. If not specified, returns all sites (given the other query parameters). If specified, returns the sites that have the specified OUID applied to them. If null, returns all sites without an OUID.

Status Codes:

  • 200 OK – Array of all site objects.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/regions/{regionID}/sites#

Creates a site.

Parameters:

  • projectName (string) – unique projectName for the resource

  • regionID (string) – unique regionID for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the created site.

DELETE /v1/projects/{projectName}/regions/{regionID}/sites/{siteID}#

Delete a site

Parameters:

  • siteID (string) – The unique site identifier.

  • projectName (string) – unique projectName for the resource

  • regionID (string) – unique regionID for the resource

Status Codes:
GET /v1/projects/{projectName}/regions/{regionID}/sites/{siteID}#

Gets a site.

Parameters:

  • siteID (string) – The unique site identifier.

  • projectName (string) – unique projectName for the resource

  • regionID (string) – unique regionID for the resource

Status Codes:

  • 200 OK – The requested site.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/regions/{regionID}/sites/{siteID}#

Partially updates a site.

Parameters:

  • siteID (string) – The unique site identifier.

  • projectName (string) – unique projectName for the resource

  • regionID (string) – unique regionID for the resource

Status Codes:

  • 200 OK – The site was patched.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PUT /v1/projects/{projectName}/regions/{regionID}/sites/{siteID}#

Updates a site.

Parameters:

  • siteID (string) – The unique site identifier.

  • projectName (string) – unique projectName for the resource

  • regionID (string) – unique regionID for the resource

Status Codes:

  • 200 OK – The site was updated.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/schedules/repeated#

Gets all repeated schedule objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • regionID (string) – The region ID target of the schedules. If not specified, returns all repeated schedules (given the other query parameters). If specified, returns the schedules that have the specified region ID applied to them, i.e., target. If null, returns all repeated schedules without a region ID as target.

  • siteID (string) – The site ID target of the schedules. If not specified, returns all repeated schedules (given the other query parameters). If specified, returns the schedules that have the specified site ID applied to them, i.e., target. If null, returns all repeated schedules without a site ID as target.

  • hostID (string) – The host ID target of the repeated schedules. If not specified, returns all repeated schedules (given the other query parameters). If specified, returns the schedules that have the specified host ID applied to them, i.e., target. If null, returns all repeated schedules without a host ID as target.

  • unix_epoch (string) – Filters based on the timestamp, expected to be UNIX epoch UTC timestamp in seconds.

Status Codes:

  • 200 OK – Arrays of all repeated schedule objects.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/schedules/repeated#

Creates a repeated schedule.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the repeated schedule created.

DELETE /v1/projects/{projectName}/schedules/repeated/{repeatedScheduleID}#

Deletes a repeated schedule.

Parameters:

  • repeatedScheduleID (string) – The unique repeated schedule identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/schedules/repeated/{repeatedScheduleID}#

Gets a repeated schedule.

Parameters:

  • repeatedScheduleID (string) – The unique repeated schedule identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The requested repeated schedule.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/schedules/repeated/{repeatedScheduleID}#

Partially updates a repeated schedule.

Parameters:

  • repeatedScheduleID (string) – The unique repeated schedule identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The repeated schedule was patched.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PUT /v1/projects/{projectName}/schedules/repeated/{repeatedScheduleID}#

Updates a repeated schedule.

Parameters:

  • repeatedScheduleID (string) – The unique repeated schedule identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The repeated schedule was updated.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/schedules/single#

Gets all single schedule objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • regionID (string) – The region ID target of the schedules. If not specified, returns all single schedules (given the other query parameters). If specified, returns the schedules that have the specified region ID applied to them, i.e., target. If null, returns all single schedules without a region ID as target.

  • siteID (string) – The site ID target of the schedules. If not specified, returns all single schedules (given the other query parameters). If specified, returns the schedules that have the specified site ID applied to them, i.e., target. If null, returns all single schedules without a site ID as target.

  • hostID (string) – The host ID target of the single schedules. If not specified, returns all single schedules (given the other query parameters). If specified, returns the schedules that have the specified host ID applied to them, i.e., target. If null, returns all single schedules without a host ID as target.

  • unix_epoch (string) – Filters based on the timestamp, expected to be UNIX epoch UTC timestamp in seconds

Status Codes:

  • 200 OK – Arrays of all single schedule objects.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/schedules/single#

Creates a single schedule to operate on an object.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the created single schedule.

DELETE /v1/projects/{projectName}/schedules/single/{singleScheduleID}#

Deletes a single schedule.

Parameters:

  • singleScheduleID (string) – The unique single schedule identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/schedules/single/{singleScheduleID}#

Gets a single schedule based on its ID.

Parameters:

  • singleScheduleID (string) – The unique single schedule identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The requested single schedule.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/schedules/single/{singleScheduleID}#

Partially updates a single schedule.

Parameters:

  • singleScheduleID (string) – The unique single schedule identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The single schedule was patched.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PUT /v1/projects/{projectName}/schedules/single/{singleScheduleID}#

Updates a single schedule.

Parameters:

  • singleScheduleID (string) – The unique single schedule identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The single schedule was updated.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/telemetry/loggroups#

Gets all telemetry log groups.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

Status Codes:

  • 200 OK – Array of all telemetry log groups.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/telemetry/loggroups#

Creates a telemetry log group.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 201 Created – The telemetry log group was created.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

Response Headers:

  • Location – Contains the URI of the telemetry log group created.

DELETE /v1/projects/{projectName}/telemetry/loggroups/{telemetryLogsGroupId}#

Deletes a telemetry log group.

Parameters:

  • telemetryLogsGroupId (string) – The unique telemetry group resource identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/telemetry/loggroups/{telemetryLogsGroupId}#

Gets a telemetry log group.

Parameters:

  • telemetryLogsGroupId (string) – The unique telemetry group resource identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The requested telemetry log group.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/telemetry/loggroups/{telemetryLogsGroupId}/logprofiles#

Gets all telemetry log profiles.

Parameters:

  • projectName (string) – unique projectName for the resource

  • telemetryLogsGroupId (string) – unique telemetryLogsGroupId for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • siteId (string) – Returns only the telemetry profiles that are assigned with the given site ID.

  • regionId (string) – Returns only the telemetry profiles that are assigned with the given region ID.

  • instanceId (string) – Returns only the telemetry profiles that are assigned with the given instance identifier.

  • showInherited (boolean) – Indicates if the listed telemetry profiles will be extended with telemetry profiles rendered from the hierarchy. This flag is used along with one of site ID, region ID or instance ID. If site ID, region ID, or instance ID are not set, this flag is ignored.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

Status Codes:

  • 200 OK – Array of all telemetry log profiles.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/telemetry/loggroups/{telemetryLogsGroupId}/logprofiles#

Creates a telemetry log profile.

Parameters:

  • projectName (string) – unique projectName for the resource

  • telemetryLogsGroupId (string) – unique telemetryLogsGroupId for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the telemetry log profile created.

DELETE /v1/projects/{projectName}/telemetry/loggroups/{telemetryLogsGroupId}/logprofiles/{telemetryLogsProfileId}#

Deletes a telemetry log profile.

Parameters:

  • telemetryLogsProfileId (string) – The unique telemetry profile identifier.

  • projectName (string) – unique projectName for the resource

  • telemetryLogsGroupId (string) – unique telemetryLogsGroupId for the resource

Status Codes:
GET /v1/projects/{projectName}/telemetry/loggroups/{telemetryLogsGroupId}/logprofiles/{telemetryLogsProfileId}#

Gets a telemetry log profile.

Parameters:

  • telemetryLogsProfileId (string) – The unique telemetry profile identifier.

  • projectName (string) – unique projectName for the resource

  • telemetryLogsGroupId (string) – unique telemetryLogsGroupId for the resource

Status Codes:

  • 200 OK – The requested telemetry log profile.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/telemetry/loggroups/{telemetryLogsGroupId}/logprofiles/{telemetryLogsProfileId}#

Partially updates a telemetry log profile.

Parameters:

  • telemetryLogsProfileId (string) – The unique telemetry profile identifier.

  • projectName (string) – unique projectName for the resource

  • telemetryLogsGroupId (string) – unique telemetryLogsGroupId for the resource

Status Codes:

  • 200 OK – The telemetry log profile was patched.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PUT /v1/projects/{projectName}/telemetry/loggroups/{telemetryLogsGroupId}/logprofiles/{telemetryLogsProfileId}#

Updates a telemetry log profile.

Parameters:

  • telemetryLogsProfileId (string) – The unique telemetry profile identifier.

  • projectName (string) – unique projectName for the resource

  • telemetryLogsGroupId (string) – unique telemetryLogsGroupId for the resource

Status Codes:

  • 200 OK – The telemetry log profile was updated.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/telemetry/metricgroups#

Gets all telemetry metric groups.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

Status Codes:

  • 200 OK – Array of all telemetry metric groups.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/telemetry/metricgroups#

Creates a telemetry metric group.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 201 Created – The telemetry metric group was created.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

Response Headers:

  • Location – Contains the URI of the telemetry metric group created.

DELETE /v1/projects/{projectName}/telemetry/metricgroups/{telemetryMetricsGroupId}#

Deletes a telemetry metric group.

Parameters:

  • telemetryMetricsGroupId (string) – The unique telemetry group resource identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/telemetry/metricgroups/{telemetryMetricsGroupId}#

Gets a telemetry metric group.

Parameters:

  • telemetryMetricsGroupId (string) – The unique telemetry group resource identifier.

  • projectName (string) – unique projectName for the resource

Status Codes:

  • 200 OK – The requested telemetry metric group.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

GET /v1/projects/{projectName}/telemetry/metricgroups/{telemetryMetricsGroupId}/metricprofiles#

Gets all telemetry metric profiles.

Parameters:

  • projectName (string) – unique projectName for the resource

  • telemetryMetricsGroupId (string) – unique telemetryMetricsGroupId for the resource

Query Parameters:

  • offset (integer) – Index of the first item to return. This allows skipping of items.

  • pageSize (integer) – Defines the amount of items to be contained in a single page, min of 1 and max of 100, default of 20.

  • siteId (string) – Returns only the telemetry profiles that are assigned with the given site ID.

  • regionId (string) – Returns only the telemetry profiles that are assigned with the given region ID.

  • instanceId (string) – Returns only the telemetry profiles that are assigned with the given instance identifier.

  • showInherited (boolean) – Indicates if the listed telemetry profiles will be extended with telemetry profiles rendered from the hierarchy. This flag is only used along with one of site ID, region ID or instance ID. If site ID, region ID, or instance ID are not set, this flag is ignored.

  • orderBy (string) – Optional comma-separated list of fields to specify a sorting order. See https://google.aip.dev/132 for details.

Status Codes:

  • 200 OK – Array of all telemetry metric profiles.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

POST /v1/projects/{projectName}/telemetry/metricgroups/{telemetryMetricsGroupId}/metricprofiles#

Creates a telemetry metric profile.

Parameters:

  • projectName (string) – unique projectName for the resource

  • telemetryMetricsGroupId (string) – unique telemetryMetricsGroupId for the resource

Status Codes:
Response Headers:

  • Location – Contains the URI of the telemetry profile created.

DELETE /v1/projects/{projectName}/telemetry/metricgroups/{telemetryMetricsGroupId}/metricprofiles/{telemetryMetricsProfileId}#

Deletes a telemetry metric profile.

Parameters:

  • telemetryMetricsProfileId (string) – The unique telemetry profile identifier.

  • projectName (string) – unique projectName for the resource

  • telemetryMetricsGroupId (string) – unique telemetryMetricsGroupId for the resource

Status Codes:
GET /v1/projects/{projectName}/telemetry/metricgroups/{telemetryMetricsGroupId}/metricprofiles/{telemetryMetricsProfileId}#

Gets a telemetry metric profile.

Parameters:

  • telemetryMetricsProfileId (string) – The unique telemetry profile identifier.

  • projectName (string) – unique projectName for the resource

  • telemetryMetricsGroupId (string) – unique telemetryMetricsGroupId for the resource

Status Codes:

  • 200 OK – The requested telemetry metric profile.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.

PATCH /v1/projects/{projectName}/telemetry/metricgroups/{telemetryMetricsGroupId}/metricprofiles/{telemetryMetricsProfileId}#

Partially updates a telemetry metric profile.

Parameters:

  • telemetryMetricsProfileId (string) – The unique telemetry profile identifier.

  • projectName (string) – unique projectName for the resource

  • telemetryMetricsGroupId (string) – unique telemetryMetricsGroupId for the resource

Status Codes:

  • 200 OK – The telemetry metric profile was patched.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

PUT /v1/projects/{projectName}/telemetry/metricgroups/{telemetryMetricsGroupId}/metricprofiles/{telemetryMetricsProfileId}#

Updates a telemetry metric profile.

Parameters:

  • telemetryMetricsProfileId (string) – The unique telemetry profile identifier.

  • projectName (string) – unique projectName for the resource

  • telemetryMetricsGroupId (string) – unique telemetryMetricsGroupId for the resource

Status Codes:

  • 200 OK – The telemetry metric profile was updated.

  • 400 Bad Request – Object in payload is not properly formulated or not related to the method.

  • 401 Unauthorized – Request is not authenticated; it either does not contain a JSON Web Token (JWT) in its header, or the JWT is not valid.

  • 403 Forbidden – Request is not authorized; it does not contain valid roles to perform a request.

  • 404 Not Found – No resource is found at the URI.

  • 406 Not Acceptable – Response content is not acceptable according to the request’s accept headers.

  • 408 Request Timeout – Request timeout.

  • 409 Conflict – Request could not be processed in the current state of the resource.

  • 412 Precondition Failed – The server does not meet one of the preconditions that the requester put on the request header fields.

  • 422 Unprocessable Entity – Unprocessable entity in parsing body request.

  • 429 Too Many Requests – Too many requests have been sent in a given amount of time.

  • 500 Internal Server Error – The provider is currently unable to handle the request because of an internal error.

  • 501 Not Implemented – The resource or method is not implemented.

  • 503 Service Unavailable – The provider is currently unable to handle the request because of a temporary overload.