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/hosts#

ListHosts

Get a list of hosts.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

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

CreateHost

Create a host.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/compute/hosts/{resourceId}#

DeleteHost

Delete a host.

Parameters:

  • resourceId (string) – Name of the host host to be deleted.

  • projectName (string) – unique projectName for the resource

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

GetHost

Get a specific host.

Parameters:

  • resourceId (string) – Name of the requested host.

  • projectName (string) – unique projectName for the resource

Status Codes:
PATCH /v1/projects/{projectName}/compute/hosts/{resourceId}#

PatchHost

Patch a host.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/compute/hosts/{resourceId}#

UpdateHost

Update a host.

Parameters:

  • resourceId (string) – Name of the host host to be updated.

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/compute/hosts/{resourceId}/invalidate#

InvalidateHost

Invalidate a host.

Parameters:

  • resourceId (string) – Host resource ID

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • note (string) – user-provided reason for change or a freeform field

Status Codes:
PATCH /v1/projects/{projectName}/compute/hosts/{resourceId}/onboard#

OnboardHost

Onboard a host.

Parameters:

  • resourceId (string) – Host resource ID

  • projectName (string) – unique projectName for the resource

Status Codes:
PATCH /v1/projects/{projectName}/compute/hosts/{resourceId}/register#

PatchRegisterHost

Update a host registration.

Parameters:

  • resourceId (string)

  • projectName (string) – unique projectName for the resource

Status Codes:
POST /v1/projects/{projectName}/compute/hosts/register#

RegisterHost

Register a host.

Parameters:

  • projectName (string) – unique projectName for the resource

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

GetHostsSummary

Get a summary of the hosts status.

Parameters:

  • projectName (string) – unique projectName for the resource

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

ListInstances

Get a list of instances.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

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

CreateInstance

Create a instance.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/compute/instances/{resourceId}#

DeleteInstance

Delete a instance.

Parameters:

  • resourceId (string) – Name of the instance instance to be deleted.

  • projectName (string) – unique projectName for the resource

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

GetInstance

Get a specific instance.

Parameters:

  • resourceId (string) – Name of the requested instance.

  • projectName (string) – unique projectName for the resource

Status Codes:
PATCH /v1/projects/{projectName}/compute/instances/{resourceId}#

PatchInstance

Patch a instance.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/compute/instances/{resourceId}#

UpdateInstance

Update a instance.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/compute/instances/{resourceId}/invalidate#

InvalidateInstance

Invalidate a instance.

Parameters:

  • resourceId (string) – Instance resource ID

  • projectName (string) – unique projectName for the resource

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

ListOperatingSystems

Get a list of OSs.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

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

CreateOperatingSystem

Create an OS

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/compute/os/{resourceId}#

DeleteOperatingSystem

Delete an OS.

Parameters:

  • resourceId (string) – Name of the os os to be deleted.

  • projectName (string) – unique projectName for the resource

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

GetOperatingSystem

Get a specific OS.

Parameters:

  • resourceId (string) – Name of the requested os.

  • projectName (string) – unique projectName for the resource

Status Codes:
PATCH /v1/projects/{projectName}/compute/os/{resourceId}#

PatchOperatingSystem

Patch an OS.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/compute/os/{resourceId}#

UpdateOperatingSystem

Update an OS.

Parameters:

  • resourceId (string) – Name of the os os to be updated.

  • projectName (string) – unique projectName for the resource

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

ListSchedules

Get a list of schedules (single/repeated).

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

  • hostId (string) –

    The host ID target of the schedules. If not specified, returns all schedules

    (given the other query params). 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 the schedules without a host ID as target.

  • siteId (string) –

    The site ID target of the schedules. If not specified, returns all schedules

    (given the other query params). 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 the schedules without a site ID as target

  • regionId (string) –

    The region ID target of the schedules. If not specified,

    returns all schedules (given the other query params). 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 the schedules without a region ID as target.

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

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

ListWorkloads

Get a list of workloads.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

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

CreateWorkload

Create a workload.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/compute/workloads/{resourceId}#

DeleteWorkload

Delete a workload.

Parameters:

  • resourceId (string) – Name of the workload workload to be deleted.

  • projectName (string) – unique projectName for the resource

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

GetWorkload

Get a specific workload.

Parameters:

  • resourceId (string) – Name of the requested workload.

  • projectName (string) – unique projectName for the resource

Status Codes:
PATCH /v1/projects/{projectName}/compute/workloads/{resourceId}#

PatchWorkload

Patch a workload.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/compute/workloads/{resourceId}#

UpdateWorkload

Update a workload.

Parameters:

  • resourceId (string) – Name of the workload workload to be updated.

  • projectName (string) – unique projectName for the resource

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

ListWorkloadMembers

Get a list of workload_members.

Parameters:

  • projectName (string) – unique projectName for the resource

  • resourceId (string) – unique resourceId for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

Status Codes:
POST /v1/projects/{projectName}/compute/workloads/{resourceId}/members#

CreateWorkloadMember

Create a workload_member.

Parameters:

  • projectName (string) – unique projectName for the resource

  • resourceId (string) – unique resourceId for the resource

Status Codes:
DELETE /v1/projects/{projectName}/compute/workloads/{workloadResourceId}/members/{resourceId}#

DeleteWorkloadMember

Delete a workload_member.

Parameters:

  • resourceId (string) – Name of the workload_member workload_member to be deleted.

  • projectName (string) – unique projectName for the resource

  • workloadResourceId (string) – unique workloadResourceId for the resource

Status Codes:
GET /v1/projects/{projectName}/compute/workloads/{workloadResourceId}/members/{resourceId}#

GetWorkloadMember

Get a specific workload_member.

Parameters:

  • resourceId (string) – Name of the requested workload_member.

  • projectName (string) – unique projectName for the resource

  • workloadResourceId (string) – unique workloadResourceId for the resource

Status Codes:
GET /v1/projects/{projectName}/customConfigs#

ListCustomConfigs

Get a list of custom configurations.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

Status Codes:
POST /v1/projects/{projectName}/customConfigs#

CreateCustomConfig

Create a custom configuration.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/customConfigs/{resourceId}#

DeleteCustomConfig

Delete a custom configuration.

Parameters:

  • resourceId (string) – Name of the customconfig to be deleted.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/customConfigs/{resourceId}#

GetCustomConfig

Get a specific custom configuration.

Parameters:

  • resourceId (string) – Name of the requested custom configuration.

  • projectName (string) – unique projectName for the resource

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

ListLocalAccounts

Get a list of providers.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

Status Codes:
POST /v1/projects/{projectName}/localAccounts#

CreateLocalAccount

Create a localAccount.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/localAccounts/{resourceId}#

DeleteLocalAccount

Delete a provider.

Parameters:

  • resourceId (string) – Name of the localaccount to be deleted.

  • projectName (string) – unique projectName for the resource

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

GetLocalAccount

Get a specific provider.

Parameters:

  • resourceId (string) – Name of the requested localaccount.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/locations#

ListLocations

Get a list of locations.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • name (string) – Filter locations by name

  • showSites (boolean) – Return site locations

  • showRegions (boolean) – Return region locations

Status Codes:
GET /v1/projects/{projectName}/os-update-policies#

ListOSUpdatePolicy

Get a list of OS Update Policies.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

Status Codes:
POST /v1/projects/{projectName}/os-update-policies#

CreateOSUpdatePolicy

Create an OS Update Policy.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/os-update-policies/{resourceId}#

DeleteOSUpdatePolicy

Delete a OS Update Policy.

Parameters:

  • resourceId (string) – Name of the OS Update Policy to be deleted.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/os-update-policies/{resourceId}#

GetOSUpdatePolicy

Get a specific OS Update Policy.

Parameters:

  • resourceId (string) – Name of the requested os.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/os-update-runs#

ListOSUpdateRun

Get a list of OS Update Policies.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

Status Codes:
DELETE /v1/projects/{projectName}/os-update-runs/{resourceId}#

DeleteOSUpdateRun

Delete a OS Update Run.

Parameters:

  • resourceId (string) – Name of the os update run to be deleted.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/os-update-runs/{resourceId}#

GetOSUpdateRun

Get a specific OS Update Run.

Parameters:

  • resourceId (string) – Name of the requested os.

  • projectName (string) – unique projectName for the resource

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

ListProviders

Get a list of providers.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

Status Codes:
POST /v1/projects/{projectName}/providers#

CreateProvider

Create a provider.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/providers/{resourceId}#

DeleteProvider

Delete a provider.

Parameters:

  • resourceId (string) – Name of the provider provider to be deleted.

  • projectName (string) – unique projectName for the resource

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

GetProvider

Get a specific provider.

Parameters:

  • resourceId (string) – Name of the requested provider.

  • projectName (string) – unique projectName for the resource

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

ListRegions

Get a list of regions.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

  • showTotalSites (boolean) – Flag to signal if the total amount of site in a region should be returned.

Status Codes:
POST /v1/projects/{projectName}/regions#

CreateRegion

Create a region.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/regions/{regionResourceId}/sites/{resourceId}#

DeleteSite

Delete a site.

Parameters:

  • resourceId (string) – Name of the site site to be deleted.

  • projectName (string) – unique projectName for the resource

  • regionResourceId (string) – unique regionResourceId for the resource

Status Codes:
GET /v1/projects/{projectName}/regions/{regionResourceId}/sites/{resourceId}#

GetSite

Get a specific site.

Parameters:

  • resourceId (string) – Name of the requested site.

  • projectName (string) – unique projectName for the resource

  • regionResourceId (string) – unique regionResourceId for the resource

Status Codes:
PATCH /v1/projects/{projectName}/regions/{regionResourceId}/sites/{resourceId}#

PatchSite

Patch a site.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

  • regionResourceId (string) – unique regionResourceId for the resource

Status Codes:
PUT /v1/projects/{projectName}/regions/{regionResourceId}/sites/{resourceId}#

UpdateSite

Update a site.

Parameters:

  • resourceId (string) – Name of the site site to be updated.

  • projectName (string) – unique projectName for the resource

  • regionResourceId (string) – unique regionResourceId for the resource

Status Codes:
DELETE /v1/projects/{projectName}/regions/{resourceId}#

DeleteRegion

Delete a region.

Parameters:

  • resourceId (string) – Name of the region region to be deleted.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/regions/{resourceId}#

GetRegion

Get a specific region.

Parameters:

  • resourceId (string) – Name of the requested region.

  • projectName (string) – unique projectName for the resource

Status Codes:
PATCH /v1/projects/{projectName}/regions/{resourceId}#

PatchRegion

Patch a region.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/regions/{resourceId}#

UpdateRegion

Update a region.

Parameters:

  • resourceId (string) – Name of the region region to be updated.

  • projectName (string) – unique projectName for the resource

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

ListSites

Get a list of sites.

Parameters:

  • projectName (string) – unique projectName for the resource

  • resourceId (string) – unique resourceId for the resource

Query Parameters:

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

  • filter (string) –

    Optional filter to return only item of interest.

    See https://google.aip.dev/160 for details.

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

Status Codes:
POST /v1/projects/{projectName}/regions/{resourceId}/sites#

CreateSite

Create a site.

Parameters:

  • projectName (string) – unique projectName for the resource

  • resourceId (string) – unique resourceId for the resource

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

ListRepeatedSchedules

Get a list of repeatedSchedules.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

  • hostId (string) –

    The host ID target of the schedules. If not specified, returns all schedules

    (given the other query params). 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 the schedules without a host ID as target.

  • siteId (string) –

    The site ID target of the schedules. If not specified, returns all schedules

    (given the other query params). 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 the schedules without a site ID as target

  • regionId (string) –

    The region ID target of the schedules. If not specified,

    returns all schedules (given the other query params). 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 the schedules without a region ID as target.

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

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

CreateRepeatedSchedule

Create a repeated_schedule.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/schedules/repeated/{resourceId}#

DeleteRepeatedSchedule

Delete a repeated_schedule.

Parameters:

  • resourceId (string) – Name of the repeated_schedule repeated_schedule to be deleted.

  • projectName (string) – unique projectName for the resource

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

GetRepeatedSchedule

Get a specific repeated_schedule.

Parameters:

  • resourceId (string) – Name of the requested repeated_schedule.

  • projectName (string) – unique projectName for the resource

Status Codes:
PATCH /v1/projects/{projectName}/schedules/repeated/{resourceId}#

PatchRepeatedSchedule

Patch a repeated_schedule.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/schedules/repeated/{resourceId}#

UpdateRepeatedSchedule

Update a repeated_schedule.

Parameters:

  • resourceId (string) – Name of the repeated_schedule repeated_schedule to be updated.

  • projectName (string) – unique projectName for the resource

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

ListSingleSchedules

Get a list of singleSchedules.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

  • hostId (string) –

    The host ID target of the schedules. If not specified, returns all schedules

    (given the other query params). 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 the schedules without a host ID as target.

  • siteId (string) –

    The site ID target of the schedules. If not specified, returns all schedules

    (given the other query params). 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 the schedules without a site ID as target

  • regionId (string) –

    The region ID target of the schedules. If not specified,

    returns all schedules (given the other query params). 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 the schedules without a region ID as target.

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

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

CreateSingleSchedule

Create a single_schedule.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/schedules/single/{resourceId}#

DeleteSingleSchedule

Delete a single_schedule.

Parameters:

  • resourceId (string) – Name of the single_schedule single_schedule to be deleted.

  • projectName (string) – unique projectName for the resource

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

GetSingleSchedule

Get a specific single_schedule.

Parameters:

  • resourceId (string) – Name of the requested single_schedule.

  • projectName (string) – unique projectName for the resource

Status Codes:
PATCH /v1/projects/{projectName}/schedules/single/{resourceId}#

PatchSingleSchedule

Patch a single_schedule.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/schedules/single/{resourceId}#

UpdateSingleSchedule

Update a single_schedule.

Parameters:

  • resourceId (string) – Name of the single_schedule single_schedule to be updated.

  • projectName (string) – unique projectName for the resource

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

ListTelemetryLogsGroups

Get a list of telemetry_logs_groups.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

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

CreateTelemetryLogsGroup

Create a telemetry_logs_group.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/telemetry/loggroups/{loggroupResourceId}/logprofiles/{resourceId}#

DeleteTelemetryLogsProfile

Delete a telemetry_logs_profile.

Parameters:

  • resourceId (string) – Name of the telemetry_logs_profile telemetry_logs_profile to be deleted.

  • projectName (string) – unique projectName for the resource

  • loggroupResourceId (string) – unique loggroupResourceId for the resource

Status Codes:
GET /v1/projects/{projectName}/telemetry/loggroups/{loggroupResourceId}/logprofiles/{resourceId}#

GetTelemetryLogsProfile

Get a specific telemetry_logs_profile.

Parameters:

  • resourceId (string) – Name of the requested telemetry_logs_profile.

  • projectName (string) – unique projectName for the resource

  • loggroupResourceId (string) – unique loggroupResourceId for the resource

Status Codes:
PATCH /v1/projects/{projectName}/telemetry/loggroups/{loggroupResourceId}/logprofiles/{resourceId}#

PatchTelemetryLogsProfile

Patch a telemetry_logs_profile.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

  • loggroupResourceId (string) – unique loggroupResourceId for the resource

Status Codes:
PUT /v1/projects/{projectName}/telemetry/loggroups/{loggroupResourceId}/logprofiles/{resourceId}#

UpdateTelemetryLogsProfile

Update a telemetry_logs_profile.

Parameters:

  • resourceId (string) – Name of the telemetry_logs_profile telemetry_logs_profile to be updated.

  • projectName (string) – unique projectName for the resource

  • loggroupResourceId (string) – unique loggroupResourceId for the resource

Status Codes:
DELETE /v1/projects/{projectName}/telemetry/loggroups/{resourceId}#

DeleteTelemetryLogsGroup

Delete a telemetry_logs_group.

Parameters:

  • resourceId (string) – Name of the telemetry_logs_group telemetry_logs_group to be deleted.

  • projectName (string) – unique projectName for the resource

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

GetTelemetryLogsGroup

Get a specific telemetry_logs_group.

Parameters:

  • resourceId (string) – Name of the requested telemetry_logs_group.

  • projectName (string) – unique projectName for the resource

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

ListTelemetryLogsProfiles

Get a list of telemetryLogsProfiles.

Parameters:

  • projectName (string) – unique projectName for the resource

  • resourceId (string) – unique resourceId for the resource

Query Parameters:

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

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

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

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

  • showInherited (boolean) –

    Indicates if listed telemetry profiles should be extended with telemetry

    profiles rendered from hierarchy. This flag is only used along with one of siteId, regionId or instanceId. If siteId, regionId or instanceId are not set, this flag is ignored.

Status Codes:
POST /v1/projects/{projectName}/telemetry/loggroups/{resourceId}/logprofiles#

CreateTelemetryLogsProfile

Create a telemetry_logs_profile.

Parameters:

  • projectName (string) – unique projectName for the resource

  • resourceId (string) – unique resourceId for the resource

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

ListTelemetryMetricsGroups

Get a list of telemetryMetricsGroups.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

Status Codes:
POST /v1/projects/{projectName}/telemetry/metricgroups#

CreateTelemetryMetricsGroup

Create a telemetry_metrics_group.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/telemetry/metricgroups/{metricgroupResourceId}/metricprofiles/{resourceId}#

DeleteTelemetryMetricsProfile

Delete a telemetry_metrics_profile.

Parameters:

  • resourceId (string) – Name of the telemetry_metrics_profile telemetry_metrics_profile to be deleted.

  • projectName (string) – unique projectName for the resource

  • metricgroupResourceId (string) – unique metricgroupResourceId for the resource

Status Codes:
GET /v1/projects/{projectName}/telemetry/metricgroups/{metricgroupResourceId}/metricprofiles/{resourceId}#

GetTelemetryMetricsProfile

Get a specific telemetry_metrics_profile.

Parameters:

  • resourceId (string) – Name of the requested telemetry_metrics_profile.

  • projectName (string) – unique projectName for the resource

  • metricgroupResourceId (string) – unique metricgroupResourceId for the resource

Status Codes:
PATCH /v1/projects/{projectName}/telemetry/metricgroups/{metricgroupResourceId}/metricprofiles/{resourceId}#

PatchTelemetryMetricsProfile

Patch a telemetry_metrics_profile.

Parameters:

  • resourceId (string) – ID of the resource to be updated.

  • projectName (string) – unique projectName for the resource

  • metricgroupResourceId (string) – unique metricgroupResourceId for the resource

Status Codes:
PUT /v1/projects/{projectName}/telemetry/metricgroups/{metricgroupResourceId}/metricprofiles/{resourceId}#

UpdateTelemetryMetricsProfile

Update a telemetry_metrics_profile.

Parameters:

  • resourceId (string) – Name of the telemetry_metrics_profile telemetry_metrics_profile to be updated.

  • projectName (string) – unique projectName for the resource

  • metricgroupResourceId (string) – unique metricgroupResourceId for the resource

Status Codes:
DELETE /v1/projects/{projectName}/telemetry/metricgroups/{resourceId}#

DeleteTelemetryMetricsGroup

Delete a telemetry_metrics_group.

Parameters:

  • resourceId (string) – Name of the telemetry_metrics_group telemetry_metrics_group to be deleted.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/telemetry/metricgroups/{resourceId}#

GetTelemetryMetricsGroup

Get a specific telemetry_metrics_group.

Parameters:

  • resourceId (string) – Name of the requested telemetry_metrics_group.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/telemetry/metricgroups/{resourceId}/metricprofiles#

ListTelemetryMetricsProfiles

Get a list of telemetryMetricsProfiles.

Parameters:

  • projectName (string) – unique projectName for the resource

  • resourceId (string) – unique resourceId for the resource

Query Parameters:

  • pageSize (integer) –

    Defines the amount of items to be contained in a single page.

    Default of 20.

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

  • orderBy (string) –

    Optional comma separated list of fields to specify a sorting order.

    See https://google.aip.dev/132 for details.

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

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

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

  • showInherited (boolean) –

    Indicates if listed telemetry profiles should be extended with telemetry

    profiles rendered from hierarchy. This flag is only used along with one of siteId, regionId or instanceId. If siteId, regionId or instanceId are not set, this flag is ignored.

Status Codes:
POST /v1/projects/{projectName}/telemetry/metricgroups/{resourceId}/metricprofiles#

CreateTelemetryMetricsProfile

Create a telemetry_metrics_profile.

Parameters:

  • projectName (string) – unique projectName for the resource

  • resourceId (string) – unique resourceId for the resource

Status Codes: