REST API reference¶
Resource Metadata (Compute Engine) REST API reference¶
Collect Google Cloud Platform Cloud Resource Metadata Compute Engine from the following APIs.
| Resources | Description | API endpoint |
|---|---|---|
| Instances | Lists currently alive Instances in given zone. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instances |
| Accelerator Types | Lists GPU(s) available for the project in given zone. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/acceleratorTypes |
| Autoscalers | Lists instance groups with autoscaling capabilities. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/autoscalers |
| Disk Types | Lists Disk types available for the project in the given zone. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/diskTypes |
| Disks | Lists disks in the given region. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks |
| Managed Instance Groups | Lists managed instance groups. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers |
| Instance Groups | Lists unmanaged instance groups. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroups |
| Machine Types | Lists types of machines available for the project in the given zone. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/machineTypes |
| Network Endpoint Groups | Lists Network Endpoint Group for the given zone. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups |
| Node Groups | Lists node groups for the given zone. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/nodeGroups |
| Node Types | Lists types of nodes available for the project in given zone. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/nodeTypes |
| Reservations | Lists reservations made. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/reservations |
| Target Instance | Lists target instances. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/targetInstances |
| Operation Resources | Lists operation for the given account for the day for selected zones. | GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/operations |
| Firewall Resources | Retrieves the list of firewalls rules available to the specified project. | GET https://compute.googleapis.com/compute/v1/projects/{project}/global/firewalls |
projects/{project}/zones/{zone}/instances¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instances
Lists currently alive Instances in given zone
Request parameters None
Returned values Lists currently alive Instances in given zone.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instances
projects/{project}/zones/{zone}/acceleratorTypes¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/acceleratorTypes
Lists GPU(s) available for the project in given zone.
Request parameters None
Returned values Lists GPU(s) available for the project in given zone.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/acceleratorTypes
projects/{project}/zones/{zone}/autoscalers¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/autoscalers
Lists instance groups with autoscaling capabilities.
Request parameters None
Returned values Lists instance groups with autoscaling capabilities.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/autoscalers
projects/{project}/zones/{zone}/diskTypes¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/diskTypes
Lists Disk types available for the project in the given zone.
Request parameters None
Returned values Lists Disk types available for the project in the given zone.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/diskTypes
projects/{project}/zones/{zone}/disks¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks
Lists disks in the given region.
Request parameters None
Returned values Lists disks in the given region.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/disks
projects/{project}/zones/{zone}/instanceGroupManagers¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers
Lists managed instance groups.
Request parameters None
Returned values Lists managed instance groups.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers
projects/{project}/zones/{zone}/instanceGroups¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroups
Lists unmanaged instance groups.
Request parameters None
Returned values Lists unmanaged instance groups.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instanceGroups
projects/{project}/zones/{zone}/machineTypes¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/machineTypes
Lists types of machines available for the project in the given zone.
Request parameters None
Returned values Lists types of machines available for the project in the given zone.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/machineTypes
projects/{project}/zones/{zone}/networkEndpointGroups¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups
Lists Network Endpoint Group for the given zone.
Request parameters None
Returned values Lists Network Endpoint Group for the given zone.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups
projects/{project}/zones/{zone}/nodeGroups¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/nodeGroups
Lists node groups for the given zone.
Request parameters None
Returned values Lists node groups for the given zone.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/nodeGroups
projects/{project}/zones/{zone}/nodeTypes¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/nodeTypes
Lists types of nodes available for the project in given zone.
Request parameters None
Returned values Lists types of nodes available for the project in given zone.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/nodeTypes
projects/{project}/zones/{zone}/reservations¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/reservations
Lists reservations made.
Request parameters None
Returned values Lists reservations made.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/reservations
projects/{project}/zones/{zone}/targetInstances¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/targetInstances
Lists target instances.
Request parameters None
Returned values Lists target instances.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/targetInstances
projects/{project}/zones/{zone}/operations¶
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/operations
Lists operation for the given account for the day for selected zones.
Request parameters None
Returned values Lists operation for the given account for the day for selected zones.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/operations
projects/{project}/global/firewalls¶
https://compute.googleapis.com/compute/v1/projects/{project}/global/firewalls
Lists target instances.
Request parameters None
Returned values Lists target instances.
Example request
curl —k u admin:password https://compute.googleapis.com/compute/v1/projects/{project}/global/firewalls
Resource Metadata (Cloud Storage) REST API reference¶
Collect Google Cloud Platform Cloud Resource Metadata Cloud Storage from the following APIs.
| Resources | Description | API endpoint |
|---|---|---|
| Buckets | List buckets available for the selected projects. | GET https://storage.googleapis.com/storage/v1/b |
| Bucket Access Controls | List ACLs for the selected bucket. | GET https://storage.googleapis.com/storage/v1/b/{bucket}/acl |
| Default Object Access Controls | List Default Object ACL for selected bucket | GET https://storage.googleapis.com/storage/v1/b/{bucket}/defaultObjectAcl |
| Notifications | List Pub/Sub notifications for the selected bucket. | GET https://storage.googleapis.com/storage/v1/b/{bucket}/notificationConfigs |
| Object Access Controls | List ACL of all the selected object. | GET https://storage.googleapis.com/storage/v1/b/{bucket}/o/{object}/acl |
b¶
https://storage.googleapis.com/storage/v1/b
List buckets available for the selected projects.
Request parameters project: A valid API project identifier.
Returned values List of buckets of selected project.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/b
b/{bucket}/acl¶
https://storage.googleapis.com/storage/v1/b/{bucket}/acl
List ACLs for the selected bucket.
Request parameters None
Returned values List of ACL for the selected bucket. Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/b/{bucket}/acl
b/{bucket}/defaultObjectAcl¶
https://storage.googleapis.com/storage/v1/b/{bucket}/defaultObjectAcl
List Default Object ACL for selected bucket
Request parameters None
Returned values List of Default object ACL for the selected bucket.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/b/{bucket}/defaultObjectAcl
b/{bucket}/notificationConfigs¶
https://storage.googleapis.com/storage/v1/b/{bucket}/notificationConfigs
List Pub/Sub notifications for the selected bucket.
Request parameters None
Returned values List of Pub/Sub notifications for the selected bucket.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/b/{bucket}/notificationConfigs
b/{bucket}/o/{object}/acl¶
https://storage.googleapis.com/storage/v1/b/{bucket}/o/{object}/acl
List ACL of all the selected object.
Request parameters None
Returned values List of ACL for the selected object.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/b/{bucket}/o/{object}/acl
Resource Metadata (Kubernetes) REST API reference¶
Collect Google Cloud Platform Cloud Resource Metadata Kubernetes from the following APIs.
| Resources | Description | API endpoint |
|---|---|---|
| Subnetworks | Lists subnetworks that are usable for creating clusters in a project. | GET https://container.googleapis.com/v1/projects/{project}/aggregated/usableSubnetworks |
| Clusters | Lists all clusters owned by a project. | GET https://container.googleapis.com/v1/projects/{project}/locations/{location}/clusters |
| Node pools | Lists the node pools for a cluster. | GET https://container.googleapis.com/v1/projects/{project}/locations/{location}/clusters/{cluster}/nodePools |
| Operations | Lists all operations in a project in the specified zone or all zones. | GET https://container.googleapis.com/v1/projects/{project}/locations/{location}/operations |
projects/{project}/aggregated/usableSubnetworks¶
https://storage.googleapis.com/storage/v1/projects/{project}/aggregated/usableSubnetworks
` Lists subnetworks that are usable for creating clusters in a project.
Request parameters None
Returned values List of Default subnetworks for the selected project.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/projects/{project}/aggregated/usableSubnetworks
projects/{project}/locations/{location}/clusters¶
https://storage.googleapis.com/storage/v1/projects/{project}/locations/{location}/clusters
Lists all clusters owned by a project.
Request parameters None
Returned values List of clusters owned by a project.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/projects/{project}/locations/{location}/clusters
projects/{project}/locations/{location}/clusters/{cluster}/nodePools¶
https://storage.googleapis.com/storage/v1/projects/{project}/locations/{location}/clusters/{cluster}/nodePools
Lists the node pools for a cluster.
Request parameters None
Returned values List of node pools for the selected cluster.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/projects/{project}/locations/{location}/clusters/{cluster}/nodePools
projects/{project}/locations/{location}/operations¶
https://storage.googleapis.com/storage/v1/projects/{project}/locations/{location}/operations
Lists all operations in a project in the specified zone or all zones.
Request parameters None
Returned values List of all operations for the selected project and location.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/projects/{project}/locations/{location}/operations
Resource Metadata (VPC Access) REST API reference¶
Collect Google Cloud Platform Cloud Resource Metadata VPC Access from the following APIs.
| Resources | Description | API endpoint |
|---|---|---|
| Locations | Lists information about the supported locations for selected project. | GET https://vpcaccess.googleapis.com/v1/projects/{project}/locations |
| Connectors | Lists Serverless VPC Access connectors. | GET https://vpcaccess.googleapis.com/v1/projects/{project}/locations/{location}/connectors |
| Operations | Lists operations that match the specified filter in the request. | GET https://vpcaccess.googleapis.com/v1/projects/{project}/locations/{location}/operations |
projects/{project}/locations¶
https://storage.googleapis.com/storage/v1/projects/{project}/locations
Lists information about the supported locations for selected project.
Request parameters None
Returned values List of supported locations for the selected project.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/projects/{project}/locations
projects/{project}/locations/{location}/connectors¶
https://storage.googleapis.com/storage/v1/projects/{project}/locations/{location}/connectors
Lists Serverless VPC Access connectors.
Request parameters None
Returned values List of Serverless VPC Access connectors.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/projects/{project}/locations/{location}/connectors
projects/{project}/locations/{location}/operations¶
https://storage.googleapis.com/storage/v1/projects/{project}/locations/{location}/operations
Lists operations that match the specified filter in the request.
Request parameters None
Returned values List of operations for selected project and location.
Example request
curl —k u admin:password https://storage.googleapis.com/storage/v1/projects/{project}/locations/{location}/operations