Red Hat Ansible Automation Platform

Red Hat Ansible Automation Platform Session API

The session API from Red Hat Ansible Automation Platform — 1 operation(s) for session.

GitHub OpenAPI

Operations 2

GET /api/gateway/v1/session/ Session retrieve #
POST /api/gateway/v1/session/ Session create #

Documentation

📖
Documentation
https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/
📖
APIReference
https://docs.ansible.com/automation-controller/latest/html/controllerapi/api_ref.html
📖
Authentication
https://docs.ansible.com/automation-controller/latest/html/controllerapi/authentication.html
📖
Documentation
https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/html/managing_red_hat_certified_and_ansible_galaxy_collections_in_automation_hub/
📖
Documentation
https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/html/event-driven_ansible_controller_user_guide/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/red-hat-ansible-automation-platform/refs/heads/main/openapi/red-hat-ansible-automation-platform-session-api-openapi.yml

Other Resources

🔗
Console
https://console.redhat.com/ansible/ansible-dashboard

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/red-hat-ansible-automation-platform-session-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

red-hat-ansible-automation-platform-session-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AAP gateway Session API
  version: v1
  description: AAP gateway API
tags:
- name: Session
paths:
  /api/gateway/v1/session/:
    get:
      operationId: session_retrieve
      tags:
      - Session
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/session_view'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/session_view_404'
          description: ''
      x-ai-description: Retrieve single session
      summary: Session retrieve
      x-summary-source: derived
    post:
      operationId: session_create
      tags:
      - Session
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/session_view_post'
          description: ''
      x-ai-description: Create new session
      summary: Session create
      x-summary-source: derived
components:
  schemas:
    session_view:
      type: object
      properties:
        now:
          type: string
          format: date-time
        expires_on:
          type: string
          format: date-time
        expires_in_seconds:
          type: integer
      required:
      - expires_in_seconds
      - expires_on
      - now
    session_view_post:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    session_view_404:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
  securitySchemes:
    Basic_Authentication:
      type: http
      scheme: basic
    OAuth2_Authentication:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /o/authorize/
          tokenUrl: /o/token/
          scopes:
            read: Read access to resources
            write: Write access to resources (includes read)
        password:
          tokenUrl: /o/token/
          scopes:
            read: Read access to resources
            write: Write access to resources (includes read)
    SessionAuthentication:
      type: apiKey
      in: cookie
      name: gateway_sessionid