Harness Rollouts API
The Rollouts API from Harness — 1 operation(s) for rollouts.
Harness Rollouts API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Rollouts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.
This API exposes 1 operation across 1 path, and defines 177 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.
1 operations
1 paths
177 schemas
1 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Harness Rollouts API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as x-api-key (x-api-key).
By default, every request must be authenticated.
x-api-key— API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Rollouts 1
GET
/gitops/api/v1/agents/{agentIdentifier}/applications/{request.name}/rollouts/status
Rollouts service get rollout status
Schemas 177
The contract defines 177 schemas that model the data the API accepts and returns. The most detailed are v1PodSpec (41 properties), v1VolumeSource (30 properties), v1RolloutInfo (25 properties), v1EphemeralContainerCommon (25 properties). Each schema is shown below with its type and property counts.
v1VsphereVirtualDiskVolumeSource
object
Represents a vSphere volume resource.
4 properties
v1ArgumentValueFrom
object
2 properties
v1DownwardAPIProjection
object
Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.
1 property
v1CanaryStep
object
CanaryStep defines a step of a canary deployment.
7 properties
v1StorageOSVolumeSource
object
Represents a StorageOS persistent volume resource.
5 properties
v1HTTPHeader
object
2 properties
v1PhotonPersistentDiskVolumeSource
object
Represents a Photon Controller persistent disk resource.
2 properties
v1FieldsV1
object
FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to…
1 property
v1AzureFileVolumeSource
object
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
3 properties
v1FCVolumeSource
object
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux…
5 properties
v1KayentaThreshold
object
2 properties
v1AWSElasticBlockStoreVolumeSource
object
Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kube…
4 properties
v1PodFailurePolicyOnExitCodesRequirement
object
PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .st…
3 properties
v1PodCertificateProjection
object
PodCertificateProjection provides a private key and X.509 certificate in the pod filesystem.
6 properties
v1GRPCAction
object
GRPCAction specifies an action involving a GRPC service.
2 properties
v1CloudWatchMetric
object
2 properties
v1TypedObjectReference
object
4 properties
v1PodTemplateSpec
object
2 properties
v1DownwardAPIVolumeSource
object
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.
2 properties
v1ContainerRestartRule
object
ContainerRestartRule describes how a container exit is handled.
2 properties
v1PodDNSConfigOption
object
PodDNSConfigOption defines DNS resolver options of a pod.
2 properties
v1EphemeralVolumeSource
object
Represents an ephemeral volume that is handled by a normal storage driver.
1 property
v1TypedLocalObjectReference
object
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. --- New uses of this type are di…
3 properties
v1PodAntiAffinity
object
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
2 properties
gatewayruntimeError
object
4 properties
v1HostPathVolumeSource
object
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
2 properties
v1AnalysisRunArgument
object
3 properties
v1DatadogMetric
object
3 properties
v1ResourceFieldSelector
object
3 properties
v1PersistentVolumeClaimSpec
object
9 properties
v1SecurityContext
object
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When…
12 properties
v1FlexVolumeSource
object
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
5 properties
v1OwnerReference
object
6 properties
v1RolloutAnalysisTemplate
object
2 properties
v1VolumeProjection
object
Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.
6 properties
v1CSIVolumeSource
object
5 properties
v1PortworxVolumeSource
object
PortworxVolumeSource represents a Portworx volume resource.
3 properties
v1ProjectedVolumeSource
object
2 properties
v1PersistentVolumeClaimTemplate
object
PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
2 properties
v1Container
object
A single application container that you want to run within a pod.
25 properties
v1AppArmorProfile
object
2 properties
v1SuccessPolicyRule
object
SuccessPolicyRule describes rule for declaring a Job as succeeded. Each rule must have at least one of the "succeededIndexes" or "succeededCount" specified.
2 properties
v1NodeAffinity
object
Node affinity is a group of node affinity scheduling rules.
2 properties
v1GlusterfsVolumeSource
object
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
3 properties
v1SeccompProfile
object
2 properties
v1SuccessPolicy
object
SuccessPolicy describes when a Job can be declared as succeeded based on the success of some indexes.
1 property
v1Capabilities
object
Adds and removes POSIX capabilities from running containers.
2 properties
resourceQuantity
object
Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() ac…
1 property
v1LabelSelector
object
2 properties
v1CephFSVolumeSource
object
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
6 properties
v1QuobyteVolumeSource
object
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
6 properties
v1ConfigMapEnvSource
object
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-val…
2 properties
v1PodSecurityContext
object
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values o…
13 properties
v1RolloutAnalysisRunInfo
object
11 properties
v1ConfigMapVolumeSource
object
Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as…
4 properties
v1PreferredSchedulingTerm
object
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is…
2 properties
v1ClusterTrustBundleProjection
object
ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.
5 properties
v1MeasurementRetention
object
MeasurementRetention defines the settings for retaining the number of measurements during the analysis.
2 properties
v1RolloutExperimentStep
object
3 properties
v1PodFailurePolicyOnPodConditionsPattern
object
PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type.
2 properties
v1ScaleIOVolumeSource
object
10 properties
v1RouteMatch
object
3 properties
v1CinderVolumeSource
object
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the…
4 properties
v1ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
15 properties
v1PodResourceClaim
object
PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the p…
3 properties
v1PodDNSConfig
object
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
3 properties
v1NodeSelector
object
1 property
v1PersistentVolumeClaimVolumeSource
object
PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A Persist…
2 properties
v1RBDVolumeSource
object
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
8 properties
v1SleepAction
object
SleepAction describes a "sleep" action.
1 property
v1EphemeralContainerCommon
object
EphemeralContainerCommon is a copy of all fields in Container to be inlined in EphemeralContainer. This separate type allows easy conversion from EphemeralCont…
25 properties
v1TCPSocketAction
object
2 properties
v1WindowsSecurityContextOptions
object
WindowsSecurityContextOptions contain Windows-specific options and credentials.
4 properties
v1SkyWalkingMetric
object
3 properties
v1CloudWatchMetricStatMetric
object
3 properties
v1Toleration
object
The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .
5 properties
v1InfluxdbMetric
object
2 properties
v1PodTemplateMetadata
object
2 properties
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
2 properties
v1CloudWatchMetricDataQuery
object
6 properties
v1Sigv4Config
object
3 properties
v1RolloutReplicaSetInfo
object
16 properties
v1CloudWatchMetricStat
object
4 properties
v1PodAffinityTerm
object
6 properties
v1TopologySpreadConstraint
object
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
8 properties
v1RolloutPodInfo
object
5 properties
v1HTTPGetAction
object
HTTPGetAction describes an action based on HTTP Get requests.
5 properties
v1JobMetric
object
2 properties
v1JobSpec
object
JobSpec describes how the job execution will look like.
16 properties
v1FileKeySelector
object
4 properties
v1VolumeDevice
object
volumeDevice describes a mapping of a raw block device within a container.
2 properties
v1SELinuxOptions
object
4 properties
v1RolloutPause
object
1 property
v1SecretProjection
object
Adapts a secret into a projected volume. The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the…
3 properties
v1RolloutJobInfo
object
5 properties
v1LocalObjectReference
object
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. --- New uses of this type are discouraged b…
1 property
v1SetCanaryScale
object
3 properties
v1SecretKeySelector
object
3 properties
v1EmptyDirVolumeSource
object
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
2 properties
v1RolloutExperimentStepAnalysisTemplateRef
object
5 properties
intstrIntOrString
object
+protobuf=true +protobuf.options.(gogoproto.goprotostringer)=false +k8s:openapi-gen=true
3 properties
v1AnalysisRunMetadata
object
2 properties
v1ServiceAccountTokenProjection
object
ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods…
3 properties
v1ResourceRequirements
object
ResourceRequirements describes the compute resource requirements.
3 properties
v1PodReadinessGate
object
1 property
v1StringMatch
object
3 properties
v1DryRun
object
DryRun defines the settings for running the analysis in Dry-Run mode.
1 property
v1WebMetric
object
8 properties
v1CloudWatchMetricStatMetricDimension
object
2 properties
v1PodFailurePolicyRule
object
PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in…
3 properties
v1MetricProvider
object
12 properties
v1PodFailurePolicy
object
PodFailurePolicy describes how failed pods influence the backoffLimit.
1 property
v1PodAffinity
object
Pod affinity is a group of inter pod affinity scheduling rules.
2 properties
v1WeightedPodAffinityTerm
object
2 properties
v1WavefrontMetric
object
2 properties
v1ImageVolumeSource
object
ImageVolumeSource represents a image volume resource.
2 properties
v1Lifecycle
object
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers,…
3 properties
v1SetMirrorRoute
object
3 properties
v1LifecycleHandler
object
LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.
4 properties
v1ContainerRestartRuleOnExitCodes
object
ContainerRestartRuleOnExitCodes describes the condition for handling an exited container based on its exit codes.
2 properties
v1NFSVolumeSource
object
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
3 properties
v1ProbeHandler
object
ProbeHandler defines a specific action that should be taken in a probe. One and only one of the fields must be specified.
4 properties
v1PrometheusAuth
object
1 property
v1NewRelicMetric
object
2 properties
v1FlockerVolumeSource
object
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownersh…
2 properties
v1RolloutInfo
object
25 properties
v1ObjectFieldSelector
object
2 properties
v1TemplateService
object
1 property
v1EnvFromSource
object
3 properties
v1Affinity
object
Affinity is a group of affinity scheduling rules.
3 properties
v1SetHeaderRoute
object
2 properties
v1ExecAction
object
ExecAction describes a "run in container" action.
1 property
v1EnvVar
object
EnvVar represents an environment variable present in a Container.
3 properties
v1ManagedFieldsEntry
object
ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
7 properties
v1NodeSelectorTerm
object
2 properties
v1RolloutExperimentTemplate
object
7 properties
v1Probe
object
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
7 properties
v1PodSchedulingGate
object
PodSchedulingGate is associated to a Pod to guard its scheduling.
1 property
v1HeaderRoutingMatch
object
2 properties
v1EphemeralContainer
object
An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have n…
2 properties
v1WebMetricHeader
object
2 properties
v1ScopeDetail
object
5 properties
v1SecretVolumeSource
object
Adapts a Secret into a volume. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the fi…
4 properties
v1ContainerResizePolicy
object
ContainerResizePolicy represents resource resize policy for the container.
2 properties
v1ISCSIVolumeSource
object
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
11 properties
v1EnvVarSource
object
EnvVarSource represents a source for the value of an EnvVar.
5 properties
v1HostAlias
object
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
2 properties
v1ContainerPort
object
ContainerPort represents a network port in a single container.
5 properties
v1GCEPersistentDiskVolumeSource
object
Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE proje…
4 properties
v1VolumeMount
object
VolumeMount describes a mounting of a Volume within a container.
7 properties
v1RolloutNonJobInfo
object
4 properties
v1GitRepoVolumeSource
object
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SEL…
3 properties
v1ResourceClaim
object
ResourceClaim references one entry in PodSpec.ResourceClaims.
2 properties
v1RolloutContainerInfo
object
2 properties
v1Metric
object
10 properties
v1KayentaMetric
object
8 properties
v1DownwardAPIVolumeFile
object
4 properties
v1Sysctl
object
2 properties
v1ConfigMapKeySelector
object
3 properties
v1SecretEnvSource
object
SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs…
2 properties
v1PrometheusMetric
object
6 properties
v1GraphiteMetric
object
2 properties
v1KeyToPath
object
Maps a string key to a path within a volume.
3 properties
v1FieldRef
object
1 property
v1VolumeSource
object
Represents the source of a volume to mount. Only one of its members may be specified.
30 properties
v1VolumeResourceRequirements
object
VolumeResourceRequirements describes the storage resource requirements for a volume.
2 properties
v1NodeSelectorRequirement
object
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
v1RolloutExperimentInfo
object
7 properties
v1AzureDiskVolumeSource
object
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
6 properties
v1PodOS
object
PodOS defines the OS parameters of a pod.
1 property
v1PodSpec
object
PodSpec is a description of a pod.
41 properties
v1ConfigMapProjection
object
Adapts a ConfigMap into a projected volume. The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys i…
3 properties
v1KayentaScope
object
3 properties
v1Time
object
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time pack…
2 properties
v1RolloutAnalysis
object
5 properties
v1Volume
object
Volume represents a named volume in a pod that may be accessed by any container in the pod.
2 properties
v1LabelSelectorRequirement
object
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Harness 12
Other APIs Harness publishes across the network.
Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
#Rollouts
Where this information came from
This is an independent, third-party profile of Harness Rollouts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.