Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat Satellite Lifecycle Environments API

Manage lifecycle environments that define promotion paths for content views from development through production.

Red Hat Satellite Lifecycle Environments API is one of 9 APIs that Red Hat Satellite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 24 JSON Schema definitions.

Tagged areas include Lifecycle Environments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, a getting-started guide, an API reference, and 24 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 6.18.0.

Requests are made against a single base URL, https://satellite.example.com.

3 operations 2 paths 1 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
6.18.0
Base URL
https://satellite.example.com/api/v2
Authentication
HTTP Basic, OAuth 2.0
License
Resource Areas
1

Authentication & Security 2

Red Hat Satellite Lifecycle Environments API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oAuth2) using the implicit flow. By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication using Satellite username and password.
  • oAuth2 — OAuth 2.0 Personal Access Token authentication for Satellite users.

Paths & Operations 3

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

Lifecycle Environments 3

Manage lifecycle environments that define promotion paths for content views from development through production.

GET
/katello/api/v2/organizations/{organization_id}/environments
List Lifecycle Environments
listLifecycleEnvironments 8 params → 200401
POST
/katello/api/v2/organizations/{organization_id}/environments
Create a Lifecycle Environment
createLifecycleEnvironment 1 param body → 201422401
GET
/katello/api/v2/organizations/{organization_id}/environments/paths
List Lifecycle Environment Paths
listLifecycleEnvironmentPaths 1 param → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is LifecycleEnvironment (12 properties). Each schema is shown below with its type and property counts.

LifecycleEnvironment
object
A lifecycle environment defining a stage in the content promotion path.
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-satellite-lifecycle-environments-api-openapi.yml Raw ↑

Other APIs Red Hat Satellite publishes across the network.

Red Hat Satellite Hammer CLI
Red Hat Satellite Foreman API
Red Hat Satellite Katello API
Red Hat Satellite Ansible Collection
Red Hat Satellite Content Views API
Red Hat Satellite Hosts API
Red Hat Satellite Organizations API
Red Hat Satellite Subscriptions API