CloudTruth Reports API

openapi: 3.2.0
info:
  title: CloudTruth Management Reports 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: Reports
paths:
  /api/v1/reports/expired-values/:
    get:
      operationId: reports_expired_values_retrieve
      tags:
      - Reports
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpiredValuesResponse'
          description: ''
      summary: Reports expired values retrieve
      x-summary-source: derived
  /api/v1/reports/expiring-values/:
    get:
      operationId: reports_expiring_values_retrieve
      tags:
      - Reports
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpiringValuesResponse'
          description: ''
      summary: Reports expiring values retrieve
      x-summary-source: derived
components:
  schemas:
    ExpiringValue:
      type: object
      properties:
        parameter:
          type: string
        environment:
          type: string
        expires_at:
          type: string
          format: date-time
        value_id:
          type: string
        parameter_id:
          type: string
        environment_id:
          type: string
        project_id:
          type: string
        expired:
          type: boolean
      required:
      - environment
      - environment_id
      - expired
      - expires_at
      - parameter
      - parameter_id
      - project_id
      - value_id
    ExpiredValue:
      type: object
      properties:
        parameter:
          type: string
        environment:
          type: string
        expires_at:
          type: string
          format: date-time
        value_id:
          type: string
        parameter_id:
          type: string
        environment_id:
          type: string
        project_id:
          type: string
      required:
      - environment
      - environment_id
      - expires_at
      - parameter
      - parameter_id
      - project_id
      - value_id
    ExpiredValuesResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/ExpiredValue'
      required:
      - results
    ExpiringValuesResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/ExpiringValue'
      required:
      - results
  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/