CloudTruth Types API

openapi: 3.2.0
info:
  title: CloudTruth Management Types API
  version: v1
  description: CloudTruth centralizes your configuration parameters and secrets making them easier to manage and use as a team.
  contact:
    name: CloudTruth Support
    email: support@cloudtruth.com
tags:
- name: Types
paths:
  /api/v1/types/:
    get:
      operationId: types_list
      parameters:
      - in: query
        name: description__icontains
        schema:
          type: string
      - in: query
        name: name__icontains
        schema:
          type: string
      - in: query
        name: name__iexact
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Types
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedParameterTypeList'
          description: ''
      summary: Types list
      x-summary-source: derived
    post:
      operationId: types_create
      tags:
      - Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParameterTypeCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ParameterTypeCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ParameterTypeCreate'
        required: true
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParameterType'
          description: ''
      summary: Types create
      x-summary-source: derived
  /api/v1/types/{parametertype_pk}/rules/:
    get:
      operationId: types_rules_list
      parameters:
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: path
        name: parametertype_pk
        schema:
          type: string
          format: uuid
        description: The parameter type id.
        required: true
      - in: query
        name: type
        schema:
          type: string
          enum:
          - max
          - max_len
          - min
          - min_len
          - one_of
          - regex
        description: '* `min` - minimum

          * `max` - maximum

          * `min_len` - minimum_length

          * `max_len` - maximum_length

          * `regex` - regex

          * `one_of` - one_of'
      tags:
      - Types
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedParameterTypeRuleList'
          description: ''
      summary: Types rules list
      x-summary-source: derived
    post:
      operationId: types_rules_create
      parameters:
      - in: path
        name: parametertype_pk
        schema:
          type: string
          format: uuid
        description: The parameter type id.
        required: true
      tags:
      - Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParameterTypeRuleCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ParameterTypeRuleCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ParameterTypeRuleCreate'
        required: true
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParameterTypeRule'
          description: ''
      summary: Types rules create
      x-summary-source: derived
  /api/v1/types/{parametertype_pk}/rules/{id}/:
    get:
      operationId: types_rules_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this parameter type rule.
        required: true
      - in: path
        name: parametertype_pk
        schema:
          type: string
          format: uuid
        description: The parameter type id.
        required: true
      tags:
      - Types
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParameterTypeRule'
          description: ''
      summary: Types rules retrieve
      x-summary-source: derived
    put:
      operationId: types_rules_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this parameter type rule.
        required: true
      - in: path
        name: parametertype_pk
        schema:
          type: string
          format: uuid
        description: The parameter type id.
        required: true
      tags:
      - Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParameterTypeRuleUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ParameterTypeRuleUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ParameterTypeRuleUpdate'
        required: true
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParameterTypeRuleUpdate'
          description: ''
      summary: Types rules update
      x-summary-source: derived
    patch:
      operationId: types_rules_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this parameter type rule.
        required: true
      - in: path
        name: parametertype_pk
        schema:
          type: string
          format: uuid
        description: The parameter type id.
        required: true
      tags:
      - Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedParameterTypeRuleUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedParameterTypeRuleUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedParameterTypeRuleUpdate'
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParameterTypeRuleUpdate'
          description: ''
      summary: Types rules partial update
      x-summary-source: derived
    delete:
      operationId: types_rules_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this parameter type rule.
        required: true
      - in: path
        name: parametertype_pk
        schema:
          type: string
          format: uuid
        description: The parameter type id.
        required: true
      tags:
      - Types
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Types rules destroy
      x-summary-source: derived
  /api/v1/types/{id}/:
    get:
      operationId: types_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
          description: A unique identifier for the parameter type.
        required: true
      tags:
      - Types
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParameterType'
          description: ''
      summary: Types retrieve
      x-summary-source: derived
    put:
      operationId: types_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
          description: A unique identifier for the parameter type.
        required: true
      tags:
      - Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParameterTypeUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ParameterTypeUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ParameterTypeUpdate'
        required: true
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParameterTypeUpdate'
          description: ''
      summary: Types update
      x-summary-source: derived
    patch:
      operationId: types_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
          description: A unique identifier for the parameter type.
        required: true
      tags:
      - Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedParameterTypeUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedParameterTypeUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedParameterTypeUpdate'
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParameterTypeUpdate'
          description: ''
      summary: Types partial update
      x-summary-source: derived
    delete:
      operationId: types_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
          description: A unique identifier for the parameter type.
        required: true
      tags:
      - Types
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Types destroy
      x-summary-source: derived
components:
  schemas:
    PatchedParameterTypeUpdate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: A unique identifier for the parameter type.
        name:
          type: string
          description: The parameter type name.
          maxLength: 256
        description:
          type: string
          description: A description of the parameter type, provide documentation on how to use this type here.
        parent:
          type: string
          format: uri
          description: The URL for this parameter type's parent
        rules:
          type: array
          items:
            $ref: '#/components/schemas/ParameterTypeRule'
          readOnly: true
          description: Rules applied to this parameter.
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
    ParameterTypeRule:
      type: object
      description: 'A type of `ModelSerializer` that uses hyperlinked relationships with compound keys instead

        of primary key relationships.  Specifically:


        * A ''url'' field is included instead of the ''id'' field.

        * Relationships to other instances are hyperlinks, instead of primary keys.


        NOTE: this only works with DRF 3.1.0 and above.'
      properties:
        url:
          type: string
          format: uri
          readOnly: true
          description: The URL for the project.
        id:
          type: string
          format: uuid
          readOnly: true
        ledger_id:
          type: string
          readOnly: true
          description: Deprecated. UUID string identifying this parameter type rule.
        parameter_type:
          type: string
          format: uri
          readOnly: true
          description: The type this rule is for.
        type:
          $ref: '#/components/schemas/ParameterRuleTypeEnum'
        constraint:
          type: string
          description: The constraint for the rule. Provided for backwards compatibility.
        constraints: {}
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - ledger_id
      - modified_at
      - parameter_type
      - type
      - url
    ParameterTypeRuleUpdate:
      type: object
      description: 'A type of `ModelSerializer` that uses hyperlinked relationships with compound keys instead

        of primary key relationships.  Specifically:


        * A ''url'' field is included instead of the ''id'' field.

        * Relationships to other instances are hyperlinks, instead of primary keys.


        NOTE: this only works with DRF 3.1.0 and above.'
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        parameter_type:
          type: string
          format: uri
          readOnly: true
          description: The type this rule is for.
        type:
          $ref: '#/components/schemas/ParameterRuleTypeEnum'
        constraint:
          type: string
          description: The constraint for the rule. Provided for backwards compatibility.
        constraints: {}
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - modified_at
      - parameter_type
      - type
    ParameterType:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
          description: The URL for the parameter type.
        id:
          type: string
          format: uuid
          readOnly: true
          description: A unique identifier for the parameter type.
        ledger_id:
          type: string
          readOnly: true
          description: Deprecated. A UUID string identifying this parameter type.
        name:
          type: string
          description: The parameter type name.
          maxLength: 256
        description:
          type: string
          description: A description of the parameter type, provide documentation on how to use this type here.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/ParameterTypeRule'
          readOnly: true
          description: Rules applied to this parameter.
        parent:
          type:
          - string
          - 'null'
          format: uri
          readOnly: true
          description: The URL for this parameter type's parent
        parent_name:
          type:
          - string
          - 'null'
          readOnly: true
          description: Name of the parent ParameterType (if any).
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - ledger_id
      - modified_at
      - name
      - parent
      - parent_name
      - rules
      - url
    PaginatedParameterTypeRuleList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/ParameterTypeRule'
    ParameterTypeCreate:
      type: object
      properties:
        name:
          type: string
          description: The parameter type name.
          maxLength: 256
        description:
          type: string
          description: A description of the parameter type, provide documentation on how to use this type here.
        parent:
          type: string
          format: uri
          description: The URL for this parameter type's parent
      required:
      - name
      - parent
    ParameterRuleTypeEnum:
      enum:
      - min
      - max
      - min_len
      - max_len
      - regex
      - one_of
      type: string
      description: '* `min` - minimum

        * `max` - maximum

        * `min_len` - minimum_length

        * `max_len` - maximum_length

        * `regex` - regex

        * `one_of` - one_of'
    PaginatedParameterTypeList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/ParameterType'
    PatchedParameterTypeRuleUpdate:
      type: object
      description: 'A type of `ModelSerializer` that uses hyperlinked relationships with compound keys instead

        of primary key relationships.  Specifically:


        * A ''url'' field is included instead of the ''id'' field.

        * Relationships to other instances are hyperlinks, instead of primary keys.


        NOTE: this only works with DRF 3.1.0 and above.'
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        parameter_type:
          type: string
          format: uri
          readOnly: true
          description: The type this rule is for.
        type:
          $ref: '#/components/schemas/ParameterRuleTypeEnum'
        constraint:
          type: string
          description: The constraint for the rule. Provided for backwards compatibility.
        constraints: {}
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
    ParameterTypeUpdate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: A unique identifier for the parameter type.
        name:
          type: string
          description: The parameter type name.
          maxLength: 256
        description:
          type: string
          description: A description of the parameter type, provide documentation on how to use this type here.
        parent:
          type: string
          format: uri
          description: The URL for this parameter type's parent
        rules:
          type: array
          items:
            $ref: '#/components/schemas/ParameterTypeRule'
          readOnly: true
          description: Rules applied to this parameter.
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - modified_at
      - name
      - parent
      - rules
    ParameterTypeRuleCreate:
      type: object
      description: 'A type of `ModelSerializer` that uses hyperlinked relationships with compound keys instead

        of primary key relationships.  Specifically:


        * A ''url'' field is included instead of the ''id'' field.

        * Relationships to other instances are hyperlinks, instead of primary keys.


        NOTE: this only works with DRF 3.1.0 and above.'
      properties:
        type:
          $ref: '#/components/schemas/ParameterRuleTypeEnum'
        constraint:
          type: string
          description: The constraint for the rule. Provided for backwards compatibility.
        constraints: {}
      required:
      - type
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey
      description: "\nUse your CloudTruth API Key to authenticate to the API.  You can get\nan API Key by creating a Service Account.  During setup of the Service\nAccount you will generate a long-lived API key intended for use by automation\nand API clients.  Access through the service account will be audited separately\nfrom any other user.\n\nIf you are just trying to use the API in a normal workflow, this is likely the\nauthentication mechanism you want to use.\n\nTo use the API Key, place your API Key in the Authorization header as 'Api-Key APIKEY', where\nAPIKEY is your CloudTruth API Key.  For example:\n\n    Authorization: Api-Key fskur.ghlsiudhrg84so938r5u\n        "
    JWTAuth:
      in: header
      name: Authorization
      type: apiKey
      description: "\nUse your JWT to authenticate to the API.  This is how the CloudTruth\nWeb UI authenticates to the backend.  It requires a user to have already logged in\nand gotten a JWT from the login process.  This is usually done by an Auth0 authentication\nflow from one of the Auth0 javascript libraries.  Alternatively, you can pull the\nJWT from your browser if you have a logged in session with the CloudTruth UI.\n\nThis authentication mechanism is intended for deeper integrations into the CloudTruth\nsystem, where you want to handle the user logins directly in your application.  For\nnormal API use, you likely want the Api-Key authentication header and not this one.\n\nTo use the JWT, place your JWT in the Authorization header as 'Bearer JWT', where\nJWT is your JWT.  For example:\n\n    Authorization: Bearer eyJhbGciOiJIkuydfy.eyJzdWIiOiIxMjM....\n        "
    tokenAuth:
      type: http
      scheme: bearer
externalDocs:
  url: https://docs.cloudtruth.com/