Tyk CertsTag API

openapi: 3.0.0
info:
  title: Tyk Dashboard Admin Additional Permissions CertsTag API
  version: 5.3.0
  description: 'For Tyk On-Premises installations only, the Dashboard Admin API has two endpoints and is used to set up and provision a Tyk Dashboard instance without the command line.


    In order to use the Dashboard Admin API, you''ll need to get the `admin_secret` value from your Tyk Dashboard configurations.


    The secret you set should then be sent along as a header with each Dashboard Admin API Request in order for it to be successful:


    ```

    admin-auth: <your-secret>

    ```'
servers:
- url: http://localhost/
- url: https://localhost/
security:
- ApiKeyAuth: []
tags:
- name: CertsTag
paths:
  /tyk/certs/{certID}:
    get:
      description: "Note that the certID path parameter can take a list of certIDs separated with commas (e.g /tyk/certs/certIDOne,certIDTwo).\n If you send a single certID it will return a single CertificateMeta object otherwise if you send more than two certIDs is will return an array of certificateMeta objects."
      operationId: listCertsWithIDs
      parameters:
      - description: Comma separated list of certificates to list.
        example: e6ce2b49-3e31-44de-95a7-12f054724283,5e9d9544a1dcd60001d0ed20a6ab77653d5da938f452bb8cc9b55b0630a6743dabd8dc92bfb025abb09ce035
        in: path
        name: certID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                certificateMetaExample:
                  $ref: '#/components/examples/certificateMetaExample'
                certificateMetaListExample:
                  $ref: '#/components/examples/certificateMetaListExample'
              schema:
                oneOf:
                - $ref: '#/components/schemas/CertsCertificateMeta'
                - items:
                    $ref: '#/components/schemas/CertsCertificateMeta'
                  nullable: true
                  type: array
          description: OK
        '403':
          content:
            application/json:
              example:
                message: Attempted administrative access with invalid or missing key!
                status: error
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                message: Certificate with given SHA256 fingerprint not found.
                status: error
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Not Found
      summary: Return One Certificate or List Multiple Certificates in the Tyk Gateway Given a Comma Separated List of Cert Ids.
      tags:
      - CertsTag
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  examples:
    certificateMetaListExample:
      value:
      - dns_names:
        - .*tyk.io
        fingerprint: 7c440d66ebb0a4629d21329808dce9091acf5f2fde328067a6e60e5347271d90
        has_private: false
        id: 5e9d9544a1dcd60001d0ed207c440d66ebb0a4629d21329808dce9091acf5f2fde328067a6e60e5347271d90
        is_ca: false
        issuer:
          CommonName: tyk.io
          Country:
          - Peachtree
          ExtraNames: null
          Locality: null
          Names:
          - Type:
            - 2
            - 5
            - 4
            - 6
            Value: Peachtree
          - Type:
            - 2
            - 5
            - 4
            - 10
            Value: tyk
          - Type:
            - 2
            - 5
            - 4
            - 11
            Value: tyk
          - Type:
            - 2
            - 5
            - 4
            - 3
            Value: tyk.io
          - Type:
            - 1
            - 2
            - 840
            - 113549
            - 1
            - 9
            - 1
            Value: support@tyk.io
          Organization:
          - tyk
          OrganizationalUnit:
          - tyk
          PostalCode: null
          Province: null
          SerialNumber: ''
          StreetAddress: null
        not_after: '2034-03-26T08:46:37Z'
        not_before: '2024-03-25T08:46:37Z'
        subject:
          CommonName: tyk.io
          Country:
          - Peachtree
          ExtraNames: null
          Locality: null
          Names:
          - Type:
            - 2
            - 5
            - 4
            - 6
            Value: Peachtree
          - Type:
            - 2
            - 5
            - 4
            - 10
            Value: tyk
          - Type:
            - 2
            - 5
            - 4
            - 11
            Value: tyk
          - Type:
            - 2
            - 5
            - 4
            - 3
            Value: tyk.io
          - Type:
            - 1
            - 2
            - 840
            - 113549
            - 1
            - 9
            - 1
            Value: support@tyk.io
          Organization:
          - tyk
          OrganizationalUnit:
          - tyk
          PostalCode: null
          Province: null
          SerialNumber: ''
          StreetAddress: null
    certificateMetaExample:
      value:
        dns_names:
        - .*tyk.io
        fingerprint: 7c440d66ebb0a4629d21329808dce9091acf5f2fde328067a6e60e5347271d90
        has_private: false
        id: 5e9d9544a1dcd60001d0ed207c440d66ebb0a4629d21329808dce9091acf5f2fde328067a6e60e5347271d90
        is_ca: false
        issuer:
          CommonName: tyk.io
          Country:
          - Peachtree
          ExtraNames: null
          Locality: null
          Names:
          - Type:
            - 2
            - 5
            - 4
            - 6
            Value: Peachtree
          - Type:
            - 2
            - 5
            - 4
            - 10
            Value: tyk
          - Type:
            - 2
            - 5
            - 4
            - 11
            Value: tyk
          - Type:
            - 2
            - 5
            - 4
            - 3
            Value: tyk.io
          - Type:
            - 1
            - 2
            - 840
            - 113549
            - 1
            - 9
            - 1
            Value: support@tyk.io
          Organization:
          - tyk
          OrganizationalUnit:
          - tyk
          PostalCode: null
          Province: null
          SerialNumber: ''
          StreetAddress: null
        not_after: '2034-03-26T08:46:37Z'
        not_before: '2024-03-25T08:46:37Z'
        subject:
          CommonName: tyk.io
          Country:
          - Peachtree
          ExtraNames: null
          Locality: null
          Names:
          - Type:
            - 2
            - 5
            - 4
            - 6
            Value: Peachtree
          - Type:
            - 2
            - 5
            - 4
            - 10
            Value: tyk
          - Type:
            - 2
            - 5
            - 4
            - 11
            Value: tyk
          - Type:
            - 2
            - 5
            - 4
            - 3
            Value: tyk.io
          - Type:
            - 1
            - 2
            - 840
            - 113549
            - 1
            - 9
            - 1
            Value: support@tyk.io
          Organization:
          - tyk
          OrganizationalUnit:
          - tyk
          PostalCode: null
          Province: null
          SerialNumber: ''
          StreetAddress: null
  schemas:
    ApiStatusMessage:
      properties:
        message:
          type: string
          example: example_value
        status:
          type: string
          example: example_value
      type: object
    CertsCertificateMeta:
      properties:
        dns_names:
          example:
          - .*tyk.io
          items:
            type: string
          type: array
        fingerprint:
          example: 7c440d66ebb0a4629d21329808dce9091acf5f2fde328067a6e60e5347271d90
          type: string
        has_private:
          example: false
          type: boolean
        id:
          example: 5e9d9544a1dcd60001d0ed207c440d66ebb0a4629d21329808dce9091acf5f2fde328067a6e60e5347271d90
          type: string
        is_ca:
          type: boolean
          example: true
        issuer:
          $ref: '#/components/schemas/PkixName'
        not_after:
          example: '2034-03-26T08:46:37Z'
          format: date-time
          type: string
        not_before:
          example: '2024-03-25T08:46:37Z'
          format: date-time
          type: string
        subject:
          $ref: '#/components/schemas/PkixName'
      type: object
    PkixName:
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Admin-Auth