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

Red Hat Ansible Automation Platform Settings API

The settings API from Red Hat Ansible Automation Platform — 6 operation(s) for settings.

Red Hat Ansible Automation Platform Settings 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.

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

This API exposes 12 operations across 6 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

12 operations 6 paths 9 schemas 3 DELETE5 GET1 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
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 Settings 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 12

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

Settings 12
GET
/api/v2/settings/
Settings list
settings_list 2 params → 200
GET
/api/v2/settings/{category_slug}/
Settings retrieve
settings_retrieve 1 param → 200
PUT
/api/v2/settings/{category_slug}/
Settings update
settings_update 1 param body → 200
PATCH
/api/v2/settings/{category_slug}/
Settings partial update
settings_partial_update 1 param body → 200
DELETE
/api/v2/settings/{category_slug}/
Settings destroy
settings_destroy 1 param → 204
POST
/api/v2/settings/logging/test/
Settings logging test create
settings_logging_test_create body → 200
GET
/api/gateway/v1/settings/
Settings list
getApiGatewayV1Settings 2 params → 200
GET
/api/gateway/v1/settings/{category_slug}/
Settings getter
settings_getter 1 param → 200
PUT
/api/gateway/v1/settings/{category_slug}/
Settings update
putApiGatewayV1SettingsByCategorySlug 1 param body → 200
DELETE
/api/gateway/v1/settings/{category_slug}/
Settings destroyer
settings_destroyer 1 param → 204
GET
/api/gateway/v1/settings/{category_slug}/{preference_name}/
Settings retrieve
getApiGatewayV1SettingsByCategorySlugByPreferenceName 2 params → 200
DELETE
/api/gateway/v1/settings/{category_slug}/{preference_name}/
Settings destroy
deleteApiGatewayV1SettingsByCategorySlugByPreferenceName 2 params → 204

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SettingSingleton (111 properties), SettingSingletonRequest (103 properties), PatchedSettingSingletonRequest (103 properties), SettingSection (42 properties). Each schema is shown below with its type and property counts.

SettingSingleton
object
Present a group of settings (by category) as a single object.
111 properties
SettingSingletonRequest
object
Present a group of settings (by category) as a single object.
103 properties
PaginatedSettingCategoryList
object
4 properties 2 required
SettingCategory
object
Serialize setting category
3 properties
PatchedSettingSingletonRequest
object
Present a group of settings (by category) as a single object.
103 properties
SettingSection
object
42 properties
PaginatedSettingSectionListList
object
4 properties 2 required
SettingSectionList
object
Serialize list of settings category
2 properties
SettingPreference
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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

Red Hat Automation Services Catalog API
Red Hat Ansible Automation Platform Access Policies API
Red Hat Ansible Automation Platform Acs: File API
Red Hat Ansible Automation Platform Activation Instances API
Red Hat Ansible Automation Platform Activations API
Red Hat Ansible Automation Platform Activity Stream API
Red Hat Ansible Automation Platform Ad Hoc Command Events API
Red Hat Ansible Automation Platform Ad Hoc Commands API
Red Hat Ansible Automation Platform AI API
Red Hat Ansible Automation Platform Analytics API
Red Hat Ansible Automation Platform Ansible: Collections API
Red Hat Ansible Automation Platform Api: API
Where this information came from

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