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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Red Hat Ansible Automation Platform

Red Hat Ansible Automation Platform Service Clusters API

The service_clusters API from Red Hat Ansible Automation Platform — 10 operation(s) for service_clusters.

Documentation Provider Profile APIs.io OpenAPI GitHub

Red Hat Ansible Automation Platform Service Clusters API is one of 333 APIs that Red Hat Ansible Automation Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 14 operations across 10 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against the base URL https://controller-host/api/v2/.

14 operations 10 paths 15 schemas 1 DELETE6 GET1 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://controller-host/api/v2/
Authentication
HTTP Basic, OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 3

Red Hat Ansible Automation Platform Service Clusters API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic_Authentication). It supports OAuth 2.0 (OAuth2_Authentication) using the authorizationCode and password flows, exposing 2 scopes. An API key is passed in the cookie as gateway_sessionid (SessionAuthentication).

Paths & Operations 14

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

service_clusters 14
GET
/api/gateway/v1/service_clusters/
Service clusters list
service_clusters_list 83 params → 200
POST
/api/gateway/v1/service_clusters/
Service clusters create
service_clusters_create body → 201
GET
/api/gateway/v1/service_clusters/{id}/
Service clusters retrieve
service_clusters_retrieve 1 param → 200
PUT
/api/gateway/v1/service_clusters/{id}/
Service clusters update
service_clusters_update 1 param body → 200
PATCH
/api/gateway/v1/service_clusters/{id}/
Service clusters partial update
service_clusters_partial_update 1 param body → 200
DELETE
/api/gateway/v1/service_clusters/{id}/
Service clusters destroy
service_clusters_destroy 1 param → 204
GET
/api/gateway/v1/service_clusters/{id}/nodes/
Service clusters nodes list
service_clusters_nodes_list 32 params → 200
GET
/api/gateway/v1/service_clusters/{id}/routes/
Service clusters routes list
service_clusters_routes_list 63 params → 200
POST
/api/gateway/v1/service_clusters/{id}/routes/associate/
Service clusters routes associate create
service_clusters_routes_associate_create 1 param body → 200
POST
/api/gateway/v1/service_clusters/{id}/routes/disassociate/
Service clusters routes disassociate create
service_clusters_routes_disassociate_create 1 param body → 200
GET
/api/gateway/v1/service_clusters/{id}/service_keys/
Service clusters service keys list
service_clusters_service_keys_list 33 params → 200
GET
/api/gateway/v1/service_clusters/{id}/service_types/
Service clusters service types list
service_clusters_service_types_list 35 params → 200
POST
/api/gateway/v1/service_clusters/{id}/service_types/associate/
Service clusters service types associate create
service_clusters_service_types_associate_create 1 param body → 200
POST
/api/gateway/v1/service_clusters/{id}/service_types/disassociate/
Service clusters service types disassociate create
service_clusters_service_types_disassociate_create 1 param body → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ServiceCluster (27 properties), PatchedServiceCluster (27 properties), AdditionalRoute (24 properties), ServiceKey (15 properties). Each schema is shown below with its type and property counts.

ServiceKey
object
15 properties 2 required
ServiceTypeDisassociate
object
Serializer used for removing objects that are currently associated via a many-to-many relationship
1 property 1 required
PaginatedAdditionalRouteList
object
4 properties 2 required
AdditionalRoute
object
Base serializer for route models. Provides common validation logic for routes including: - Gateway authentication validation for internal routes - Mutual TLS (…
24 properties 7 required
ServiceCluster
object
27 properties 2 required
ServiceTypeAssociate
object
Serializer used for adding objects to a many-to-many relationship
1 property 1 required
PatchedServiceCluster
object
27 properties
ServiceNode
object
12 properties 3 required
AdditionalRouteAssociate
object
Serializer used for adding objects to a many-to-many relationship
1 property 1 required
PaginatedServiceClusterList
object
4 properties 2 required
AdditionalRouteDisassociate
object
Serializer used for removing objects that are currently associated via a many-to-many relationship
1 property 1 required
PaginatedServiceTypeList
object
4 properties 2 required
PaginatedServiceNodeList
object
4 properties 2 required
PaginatedServiceKeyList
object
4 properties 2 required
ServiceType
object
13 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-service-clusters-api-openapi.yml Raw ↑

Other APIs Red Hat Ansible Automation Platform publishes across the network.

Red Hat Automation Services Catalog API
AE Profile APIs.io
Red Hat Ansible Automation Platform Access Policies API
AE Profile APIs.io
Red Hat Ansible Automation Platform Acs: File API
AE Profile APIs.io
Red Hat Ansible Automation Platform Activation Instances API
AE Profile APIs.io
Red Hat Ansible Automation Platform Activations API
AE Profile APIs.io
Red Hat Ansible Automation Platform Activity Stream API
AE Profile APIs.io
Red Hat Ansible Automation Platform Ad Hoc Command Events API
AE Profile APIs.io
Red Hat Ansible Automation Platform Ad Hoc Commands API
AE Profile APIs.io
Red Hat Ansible Automation Platform AI API
AE Profile APIs.io
Red Hat Ansible Automation Platform Analytics API
AE Profile APIs.io
Red Hat Ansible Automation Platform Ansible: Collections API
AE Profile APIs.io
Red Hat Ansible Automation Platform Api: API
AE Profile APIs.io
← Back to R APIs
API Details
ID
red-hat-ansible-automation-platform:red-hat-ansible-automation-platform-service-clusters-api
Base URL
https://controller-host/api/v2/
Docs
https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/
Provider
Red Hat Ansible Automation Platform
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=red-hat-ansible-automation-platform-service-clusters-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/red-hat-ansible-automation-platform-service-clusters-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Red Hat Ansible Automation Platform Service Clusters 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.