workload
Get a deployment by GVC, workload and name
- Blog
- FAQ
- Product Demos
- API Guide
- GETGet an agent by name
- DELDelete an agent by name
- PATCHPerform a Patch on an agent by name
- GETQuery agent health
- GETGet all agents
- POSTCreate an agent
- POSTGet all agents based on a query
- GETGet the access report for an agent by name
- GETGet available permissions for an agent
- GETGet an audit context by name
- PATCHPerform a Patch on an audit context by name
- GETGet all audit contexts
- POSTCreate an audit context
- POSTGet all audit contexts based on a query
- GETGet the access report for an audit context by name
- GETGet available permissions for an audit context
- GETGet a cloud account by name
- DELDelete an cloud account by name
- PATCHPerform a Patch on a cloud account by name
- GETGet all cloud accounts
- POSTCreate a cloud account
- POSTGet all cloud accounts based on a query
- GETGet the access report for a cloud account by name
- GETGet available permissions for a cloud account resource type
- GETGet a domain by name
- DELDelete a domain by name
- PATCHPerform a Patch on a domain by name
- GETGet all domains
- POSTCreate a domain
- POSTGet all domains based on a query
- GETGet the access report for a domain by name
- GETGet available permissions for a domain resource type
- GETGet a group by name
- DELDelete a group by name
- PATCHPerform a Patch on a group by name
- GETGet all groups
- POSTCreate a group
- POSTGet all groups based on a query
- GETGet the access report for a group by name
- GETGet available permissions for a group resource type
- GETGet a GVC by name
- DELDelete a GVC by name
- PATCHPerform a Patch on a GVC by name
- GETGet all GVCs
- POSTCreate a GVC
- POSTGet all GVCs based on a query
- GETGet the access report for a GVC by name
- GETGet available permissions for a GVC resource type
- GETGet an identity by GVC and name
- DELDelete an identity by GVC and name
- PATCHPerform a Patch on an identity by name
- GETGet all identities in a GVC
- POSTCreate an identity
- GETGet all identities from all GVCs
- POSTGet all GVC identities based on a query
- GETGet the access report for an identity by GVC and name
- GETGet available permissions for an identity
- GETGet a image by name
- DELDelete an image by name
- PATCHPerform a Patch on an image by name
- GETGet all images
- POSTGet all images based on a query
- GETGet the access report for an image by name
- GETGet available permissions for an image resource type
- GETGet a location by name
- PATCHPerform a Patch on a location by name
- GETGet all locations
- POSTGet all locations based on a query
- GETGet the access report for a location by name
- GETGet available permissions for a location resource type
- GETGet an org by name
- PATCHPerform a Patch on an org by name
- GETGet all orgs
- POSTCreate an org
- POSTGet all orgs based on a query
- GETGet the access report for an org by name
- GETGet available permissions for an org resource type
- GETGet a policy by name
- DELDelete a policy by name
- PATCHPerform a Patch on a policy by name
- GETGet all policies
- POSTCreate a policy
- POSTGet all policies based on a query
- GETGet the access report for a policy by name
- GETGet available permissions for a policy resource type
- GETGet a quota by ID
- GETGet all quotas
- POSTGet all quotas based on a query
- GETGet available permissions for a quota resource type
- GETGet a secret by name
- DELDelete a secret by name
- PATCHPerform a Patch on a secret by name
- GETGet all secrets
- POSTCreate a secret
- GETGet the sensitive content of a secret by name
- POSTGet all secrets based on a query
- GETGet the access report for a secret by name
- GETGet available permissions for a secret resource type
- GETGet a service account by name
- DELDelete a service account by name
- PATCHPerform a Patch on a service account by name
- GETGet all service accounts
- POSTCreate a service account
- POSTGet all service accounts based on a query
- GETGet the access report for a service account by name
- POSTAdd a key to a service account
- GETGet available permissions for a service account resource type
- GETList tasks that you can accept to refuse
- GETList tasks that you can accept to refuse in a specific org
- GETGet a task by ID
- POSTPost
- DELDelete/Cancel a task by ID
- GETGet all tasks
- POSTGet all tasks based on a query
- GETGet available permissions for a task resource type
- GETGet a user by name
- DELDelete a user by name
- PATCHPerform a Patch on a user by name
- GETGet all users
- POSTGet all users based on a query
- POSTInvite users to this org
- GETGet the access report for a user by name
- GETGet available permissions for a user resource type
- GETGet a volumeset by GVC and name
- DELDelete a volumeset by name
- PATCHPerform a Patch on a volumeset by name
- GETList volumesets in a GVC you are authorized to view
- POSTCreate a volumeset
- GETGet all volumesets
- POSTGet all volumesets based on a query
- GETGet the access report for a volumeset by GVC and name
- GETGet available permissions for a volumeset resource type
- GETGet a workload by GVC and name
- DELDelete a workload by name
- PATCHPerform a Patch on a workload by name
- GETGet a deployment by GVC, workload and name
- GETList workloads in a GVC you are authorized to view
- POSTCreate a workload
- GETGet all workloads
- GETList deployments in a workload
- POSTGet all workloads based on a query
- GETGet the access report for a workload by GVC and name
- GETGet available permissions for a workload resource type
Overview
agent
auditctx
cloudaccount
domain
group
gvc
identity
image
location
org
policy
quota
secret
serviceaccount
task
user
volumeset
workload
workload
Get a deployment by GVC, workload and name
Fetch a specific deployment of a workload
GET
/
org
/
{org}
/
gvc
/
{gvc}
/
workload
/
{workload}
/
deployment
/
{name}
Authorization
string
*
Authorization
Required
string
Service account key can be used as API keys
org
string
*
org
Required
string
gvc
string
*
gvc
Required
string
workload
string
*
workload
Required
string
name
string
*
name
Required
string
Authorizations
Authorization
string
headerrequiredService account key can be used as API keys
Path Parameters
org
string
requiredgvc
string
requiredworkload
string
requiredname
string
requiredResponse
200 - application/json
name
string
kind
string
links
object[]
links.rel
string
links.href
string
lastModified
string
status
object
status.endpoint
string
status.remote
string
status.lastProcessedVersion
integer
status.expectedDeploymentVersion
integer
status.internal
object
status.ready
boolean
status.deploying
boolean
status.versions
object[]
status.versions.name
string
status.versions.created
string
status.versions.workload
number
status.versions.gvc
number
status.versions.containers
object
status.versions.ready
boolean
status.versions.message
string
status.jobExecutions
object[]
status.jobExecutions.workloadVersion
number
The version of the workload used during this job execution
status.jobExecutions.status
enum<string>
default: pendingThe result of the job execution.
Available options:
successful, failed, active, pending, invalid, removed, status.jobExecutions.startTime
string
The time the job execution was first moved from pending to active. If the job execution was never pending, this is equivalent to the creation time of the job execution.
status.jobExecutions.completionTime
string
The time the job execution finished. This should not be interpreted as an indication of success. Please refer to the status field instead.
status.jobExecutions.conditions
object[]
status.jobExecutions.conditions.status
enum<string>
default: UnknownAvailable options:
True, False, Unknown status.jobExecutions.conditions.type
enum<string>
Available options:
Complete, Failed, Suspended status.jobExecutions.conditions.lastDetectionTime
string
The last time this condition was detected by Control Plane.
status.jobExecutions.conditions.lastTransitionTime
string
The last time this condition transitioned between states.
status.jobExecutions.conditions.message
string
status.jobExecutions.conditions.reason
string
A concise explanation of the most recent state transition.
status.jobExecutions.name
string
The name of the Job objects in kubernetes
status.jobExecutions.containers
object
status.message
string