Red Hat Ansible Automation Platform Signing Services API

openapi: 3.2.0
info:
  title: Automation Hub Signing Services API
  version: v3
  description: Fetch, Upload, Organize, and Distribute Ansible Collections
  contact:
    name: Automation Hub Team
    email: ansible-galaxy-team@redhat.com
    url: https://www.ansible.com/products/automation-hub
  license:
    name: GPLv2+
    url: https://raw.githubusercontent.com/ansible/galaxy_ng/main/LICENSE
  x-logo:
    url: https://pulp.plan.io/attachments/download/517478/pulp_logo_word_rectangle.svg
  x-pulp-app-versions:
    core: 3.49.40
    galaxy: 4.12.0dev
    ansible: 0.25.1
    container: 2.19.5
    certguard: 3.49.40
    file: 3.49.40
  x-pulp-domain-enabled: false
servers:
- url: http://automation-hub-backend-cwa.automation-hub-prod.svc.cluster.local:8000/
tags:
- name: Signing-Services
paths:
  /api/automation-hub/pulp/api/v3/signing-services/:
    get:
      operationId: signing_services_list
      description: A ViewSet that supports browsing of existing signing services.
      summary: List signing services
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: name
        schema:
          type: string
        description: Filter results where name matches value
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: ordering
        schema:
          type: array
          items:
            type: string
            enum:
            - -name
            - -pk
            - -pubkey_fingerprint
            - -public_key
            - -pulp_created
            - -pulp_id
            - -pulp_last_updated
            - -script
            - name
            - pk
            - pubkey_fingerprint
            - public_key
            - pulp_created
            - pulp_id
            - pulp_last_updated
            - script
        description: 'Ordering


          * `pulp_id` - Pulp id

          * `-pulp_id` - Pulp id (descending)

          * `pulp_created` - Pulp created

          * `-pulp_created` - Pulp created (descending)

          * `pulp_last_updated` - Pulp last updated

          * `-pulp_last_updated` - Pulp last updated (descending)

          * `name` - Name

          * `-name` - Name (descending)

          * `public_key` - Public key

          * `-public_key` - Public key (descending)

          * `pubkey_fingerprint` - Pubkey fingerprint

          * `-pubkey_fingerprint` - Pubkey fingerprint (descending)

          * `script` - Script

          * `-script` - Script (descending)

          * `pk` - Pk

          * `-pk` - Pk (descending)'
        explode: false
        style: form
      - in: query
        name: pulp_href__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: pulp_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: q
        schema:
          type: string
      - in: query
        name: fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to include in the response.
      - in: query
        name: exclude_fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to exclude from the response.
      tags:
      - Signing-Services
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSigningServiceResponseList'
          description: ''
  /api/automation-hub/pulp/api/v3/signing-services/{pulp_id}/:
    get:
      operationId: signing_services_read
      description: A ViewSet that supports browsing of existing signing services.
      summary: Inspect a signing service
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this signing service.
        required: true
      - in: query
        name: fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to include in the response.
      - in: query
        name: exclude_fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to exclude from the response.
      tags:
      - Signing-Services
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningServiceResponse'
          description: ''
components:
  schemas:
    PaginatedSigningServiceResponseList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/SigningServiceResponse'
    SigningServiceResponse:
      type: object
      description: A serializer for the model declaring a signing service.
      properties:
        pulp_href:
          type: string
          format: uri
          readOnly: true
        pulp_created:
          type: string
          format: date-time
          readOnly: true
          description: Timestamp of creation.
        pulp_last_updated:
          type: string
          format: date-time
          readOnly: true
          description: 'Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.'
        name:
          type: string
          description: A unique name used to recognize a script.
        public_key:
          type: string
          description: The value of a public key used for the repository verification.
        pubkey_fingerprint:
          type: string
          description: The fingerprint of the public key.
        script:
          type: string
          description: An absolute path to a script which is going to be used for the signing.
      required:
      - name
      - pubkey_fingerprint
      - public_key
      - script