Cloud Run Admin API
Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving…
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/.
Endpoints 30
projects.locations
- POSTExport image for a given resource.
/v2/:name:exportImageExport image for a given resource. - GETExport image metadata for a given resource.
/v2/:name:exportImageMetadataExport image metadata for a given resource. - GETExport generated customer metadata for a given resource.
/v2/:name:exportMetadataExport generated customer metadata for a given resource. - GETExport generated customer metadata for a given project.
/v2/:name:exportProjectMetadataExport generated customer metadata for a given project.
projects.locations.builds
- POSTSubmits a build in a given project.
/v2/:parent/builds:submitSubmits a build in a given project.
projects.locations.instances
- GETLists Instances
/v2/:parent/instances?pageSize=0&pageToken=string&showDeleted=trueLists Instances. Results are sorted by creation time, descending. - POSTCreates an Instance.
/v2/:parent/instances?instanceId=string&validateOnly=trueCreates an Instance. - POSTStarts an Instance.
/v2/:name:startStarts an Instance. - POSTStops an Instance.
/v2/:name:stopStops an Instance.
projects.locations.workerPools.revisions
- GETGets information about a Revision.
/v2/:nameGets information about a Revision. - DELETEDeletes a Revision.
/v2/:name?etag=string&validateOnly=trueDeletes a Revision. - GETLists Revisions from a given Service, or from a given location
/v2/:parent/revisions?pageSize=0&pageToken=string&showDeleted=trueLists Revisions from a given Service, or from a given location. Results are sorted by creation time, descending.
projects.locations.workerPools
- PATCHUpdates a WorkerPool.
/v2/:name?allowMissing=true&forceNewRevision=true&updateMask=string&validateOnly=trueUpdates a WorkerPool. - GETGets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool
/v2/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool. This result does not include any inherited policies. - POSTSets the IAM Access control policy for the specified WorkerPool
/v2/:resource:setIamPolicySets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy. - POSTReturns permissions that a caller has on the specified Project
/v2/:resource:testIamPermissionsReturns permissions that a caller has on the specified Project. There are no permissions required for making this API call. - GETLists WorkerPools
/v2/:parent/workerPools?pageSize=0&pageToken=string&showDeleted=trueLists WorkerPools. Results are sorted by creation time, descending. - POSTCreates a new WorkerPool in a given project and location.
/v2/:parent/workerPools?validateOnly=true&workerPoolId=stringCreates a new WorkerPool in a given project and location.
projects.locations.jobs
- GETLists Jobs
/v2/:parent/jobs?pageSize=0&pageToken=string&showDeleted=trueLists Jobs. Results are sorted by creation time, descending. - POSTCreates a Job.
/v2/:parent/jobs?jobId=string&validateOnly=trueCreates a Job. - POSTTriggers creation of a new Execution of this Job.
/v2/:name:runTriggers creation of a new Execution of this Job.
projects.locations.jobs.executions
- POSTCancels an Execution.
/v2/:name:cancelCancels an Execution. - GETLists Executions from a Job
/v2/:parent/executions?pageSize=0&pageToken=string&showDeleted=trueLists Executions from a Job. Results are sorted by creation time, descending.
projects.locations.services.revisions
- GETRead the status of an image export operation.
/v2/:name/:operationId:exportStatusRead the status of an image export operation.
projects.locations.jobs.executions.tasks
- GETLists Tasks from an Execution of a Job.
/v2/:parent/tasks?pageSize=0&pageToken=string&showDeleted=trueLists Tasks from an Execution of a Job.
projects.locations.operations
- GETLists operations that match the specified filter in the request
/v2/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. - POSTWaits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest…
/v2/:name:waitWaits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done,…
projects.locations.services
- GETLists Services
/v2/:parent/services?pageSize=0&pageToken=string&showDeleted=trueLists Services. Results are sorted by creation time, descending. - POSTCreates a new Service in a given project and location.
/v2/:parent/services?serviceId=string&validateOnly=trueCreates a new Service in a given project and location.
projects.locations.sourceUploads
- POSTUploads a source archive to a Google Cloud Storage bucket through Cloud Run
/v2/:parent:uploadSourceUploads a source archive to a Google Cloud Storage bucket through Cloud Run. The uploaded source object should be used for Cloud Run resource deployments.…
API details
- Base URL
https://run.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 3 scopes
An API key in the key query parameter - Operations
- 30 operations on 24 pathsGET 14POST 14PATCH 1DELETE 1
- Main resources
- projects.locations.workerPools 6projects.locations 4projects.locations.instances 4projects.locations.jobs 3projects.locations.workerPools.revisions 3projects.locations.jobs.executions 2projects.locations.operations 2projects.locations.services 2projects.locations.builds 1projects.locations.jobs.executions.tasks 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v2 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Run Admin API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Run Admin API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Export image for a given resource.” (POST /v2/:name:exportImage), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Run Admin API?
Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving… It is listed under Developer tools and has 30 endpoints.
Who publishes the Cloud Run Admin API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud Run Admin API?
Requests go to https://run.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Run Admin API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 3 scopes; an API key in the key query parameter.
How many endpoints does the Cloud Run Admin API have?
30 operations on 24 paths (14 GET, 14 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.workerPools, projects.locations, projects.locations.instances, projects.locations.jobs.
Is forking the Cloud Run Admin API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.