How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenShift DeploymentConfigs API

Manage OpenShift DeploymentConfigs which provide declarative deployment lifecycle management with rolling, recreate, and custom strategies, plus automatic rollback and deployment triggers.

OpenShift DeploymentConfigs API is one of 31 APIs that OpenShift publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deployment Configs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, pricing, a support channel, and rate-limit docs.

This API exposes 13 operations across 7 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version 4.17.0.

Requests are made against a single base URL, https://api.openshift.com.

13 operations 7 paths 23 schemas 1 DELETE6 GET1 PATCH2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.17.0
Base URL
https://api.openshift.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

OpenShift DeploymentConfigs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerToken). By default, every request must be authenticated.

  • BearerToken — OAuth bearer token obtained from the OpenShift OAuth server. Use 'oc whoami -t' to retrieve a token, or configure an OAuth client for programmatic access.

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 1 DELETE, 6 GET, 1 PATCH, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

DeploymentConfigs 13

Manage OpenShift DeploymentConfigs which provide declarative deployment lifecycle management with rolling, recreate, and custom strategies, plus automatic rollback and deployment…

GET
/apis/apps.openshift.io/v1/deploymentconfigs
Openshift List Deployment Configs Across All Namespaces
listDeploymentConfigForAllNamespaces 8 params → 200401
GET
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs
Openshift List Deployment Configs in a Namespace
listNamespacedDeploymentConfig 9 params → 200401
POST
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs
Openshift Create a Deployment Config
createNamespacedDeploymentConfig 4 params body → 200201202401
GET
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}
Openshift Read a Deployment Config
readNamespacedDeploymentConfig 3 params → 200401
PUT
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}
Openshift Replace a Deployment Config
replaceNamespacedDeploymentConfig 5 params body → 200201401
PATCH
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}
Openshift Patch a Deployment Config
patchNamespacedDeploymentConfig 5 params body → 200401
DELETE
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}
Openshift Delete a Deployment Config
deleteNamespacedDeploymentConfig 6 params → 200202401
GET
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/status
Openshift Read Status of a Deployment Config
readNamespacedDeploymentConfigStatus 3 params → 200401
PUT
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/status
Openshift Replace Status of a Deployment Config
replaceNamespacedDeploymentConfigStatus 5 params body → 200201401
GET
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/scale
Openshift Read Scale of a Deployment Config
readNamespacedDeploymentConfigScale 3 params → 200401
PUT
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/scale
Openshift Replace Scale of a Deployment Config
replaceNamespacedDeploymentConfigScale 5 params body → 200201401
POST
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/rollback
Openshift Rollback a Deployment Config
createNamespacedDeploymentConfigRollback 5 params body → 200201401
GET
/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/log
Openshift Read Deployment Config Log
readNamespacedDeploymentConfigLog 8 params → 200401

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are ObjectMeta (11 properties), Container (11 properties), DeploymentConfigSpec (9 properties), DeploymentConfigStatus (8 properties). Each schema is shown below with its type and property counts.

DeploymentConfigList
object
A list of DeploymentConfig objects.
4 properties 1 required
DeploymentConfigRollback
object
A request to roll back a deployment to a previous version.
4 properties 2 required
ObjectReference
object
A reference to a Kubernetes object.
4 properties
RecreateDeploymentStrategyParams
object
Parameters for a recreate deployment strategy.
1 property
ResourceRequirements
object
Compute resource requirements for a container.
2 properties
OwnerReference
object
Contains information to identify an owning object.
6 properties 4 required
EnvVar
object
An environment variable to set in a container.
2 properties 1 required
Status
object
Status is a return value for calls that do not return other objects.
7 properties
DeploymentConfigSpec
object
Specification for the desired deployment behavior.
9 properties
Scale
object
Represents a scaling request for a resource.
5 properties
DeploymentStrategy
object
Describes how to perform a deployment.
6 properties
CustomDeploymentStrategyParams
object
Parameters for a custom deployment strategy.
3 properties
PodSpec
object
Specification of the desired behavior of a pod.
6 properties
DeploymentTriggerPolicy
object
A policy that triggers new deployments.
2 properties
PodTemplateSpec
object
Describes the data a pod should have when created from a template.
2 properties
ListMeta
object
Metadata for list responses including pagination tokens.
4 properties
DeploymentCondition
object
Describes the state of a deployment at a point in time.
6 properties
Container
object
A single application container running within a pod.
11 properties 2 required
DeploymentConfig
object
A DeploymentConfig describes the desired state of a particular application deployment. It creates ReplicationControllers to manage pods and supports rolling, r…
5 properties 1 required
RollingDeploymentStrategyParams
object
Parameters for a rolling deployment strategy.
5 properties
DeploymentConfigStatus
object
Status of the DeploymentConfig.
8 properties
ObjectMeta
object
Standard Kubernetes object metadata. Every resource includes metadata such as name, namespace, labels, and annotations.
11 properties
Probe
object
Describes a health check to be performed against a container.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openshift-deploymentconfigs-api-openapi.yml Raw ↑

Other APIs OpenShift publishes across the network.

OpenShift OAuth API
OpenShift Routes API
OpenShift Build API
OpenShift Image API
OpenShift Project API
OpenShift Workloads API
OpenShift Network API
OpenShift Storage API
OpenShift Authorization API
OpenShift Autoscale API
OpenShift Config API
OpenShift Console API
Where this information came from

This is an independent, third-party profile of OpenShift DeploymentConfigs 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.