Nile Credentials API

openapi: 3.2.0
info:
  title: Thenile Credentials API
  version: 0.1.0-72f73d7
  contact:
    email: support@thenile.dev
  description: 'Operations tagged credentials across 2 of this provider''s published API definitions: global-openapi.json, thenile-global-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://global.thenile.dev
tags:
- name: Credentials
paths:
  /workspaces/{workspaceSlug}/databases/{databaseName}/credentials:
    get:
      tags:
      - Credentials
      summary: Lists credentials for a database
      description: 'Lists all credentials that exist for a database. The id of the credential is

        included in the response, but not the password. Passwords are provided only once,

        at the time the credential is created, and are encrypted for storage.'
      operationId: listCredentials
      parameters:
      - name: workspaceSlug
        in: path
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - name: tenantId
        in: query
        schema:
          type: string
      - name: internal
        in: query
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: A list of Credential objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetCredentialResponse'
        '401':
          description: Unauthorized. Credentials were missing or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '403':
          description: Forbidden. The credentials provided do not grant access to the requested resource(s).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      security:
      - jwtBearerAuth: []
    post:
      tags:
      - Credentials
      summary: Create a database credential
      description: 'Generates a new secure credential for a database. The generated password is

        returned in the response, and is the only time the password is available in

        plaintext. No request body is required."'
      operationId: createCredential
      parameters:
      - name: workspaceSlug
        in: path
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - name: tenantId
        in: query
        schema:
          type: string
      - name: internal
        in: query
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Credential created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCredentialResponse'
        '401':
          description: Unauthorized. Credentials were missing or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '403':
          description: Forbidden. The credentials provided do not grant access to the requested resource(s).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      security:
      - jwtBearerAuth: []
    servers:
    - url: https://global.thenile.dev
  /workspaces/{workspaceSlug}/databases/{databaseName}/credentials/{credentialId}:
    delete:
      tags:
      - Credentials
      summary: Delete a database credential
      description: Deletes an existing database credential. No request body is required."
      operationId: deleteCredential
      parameters:
      - name: workspaceSlug
        in: path
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - name: credentialId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Credential deleted
        '401':
          description: Unauthorized. Credentials were missing or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '403':
          description: Forbidden. The credentials provided do not grant access to the requested resource(s).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
      security:
      - jwtBearerAuth: []
    servers:
    - url: https://global.thenile.dev
  /workspaces/{workspaceSlug}/databases/{databaseName}/credentials/rotate:
    post:
      tags:
      - Credentials
      summary: Rotate a database credential
      description: Generates a new credential and schedules existing credentials for deletion after the provided delay.
      operationId: rotateCredential
      parameters:
      - name: workspaceSlug
        in: path
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - name: tenantId
        in: query
        schema:
          type: string
      - name: internal
        in: query
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/RotateCredentialRequest'
      responses:
        '200':
          description: New credential after rotation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCredentialResponse'
      security:
      - jwtBearerAuth: []
    servers:
    - url: https://global.thenile.dev
components:
  schemas:
    DatabaseParentResponse:
      required:
      - id
      - name
      type: object
      properties:
        id:
          type: string
        name:
          minLength: 1
          type: string
    Workspace:
      required:
      - name
      - slug
      type: object
      properties:
        id:
          type: string
        name:
          minLength: 1
          type: string
        slug:
          minLength: 1
          type: string
        stripe_customer_id:
          type: string
        created:
          type: string
          format: date-time
    GetDatabaseResponse:
      required:
      - expandable
      - id
      - name
      - region
      - status
      - workspace
      type: object
      properties:
        id:
          type: string
        name:
          minLength: 1
          type: string
        workspace:
          $ref: '#/components/schemas/Workspace'
        status:
          type: string
          enum:
          - PENDING
          - REQUESTED
          - BUILT
          - POOLED
          - READY
        region:
          type: string
          enum:
          - AWS_US_WEST_2
          - AWS_US_EAST_1
          - AWS_EU_CENTRAL_1
          - AZURE_EASTUS
        expandable:
          type: boolean
        created:
          type: string
          format: date-time
        deleted:
          type: string
          format: date-time
        apiHost:
          type:
          - string
          - 'null'
          description: Public database API URL; Since it is only used for tenants/users management, it is null for un-sharded databases.
          format: uri
        dbHost:
          type: string
          format: uri
        parent:
          $ref: '#/components/schemas/DatabaseParentResponse'
    APIError:
      required:
      - errorCode
      - message
      - statusCode
      type: object
      properties:
        errorCode:
          type: string
          enum:
          - internal_error
          - bad_request
          - unsupported_operation
          - forbidden_operation
          - entity_not_found
          - duplicate_entity
          - invalid_credentials
          - unknown_oidc_provider
          - unknown_oidc_party
          - provider_already_exists
          - provider_config_error
          - provider_mismatch
          - provider_update_error
          - provider_disabled
          - session_state_missing
          - session_state_mismatch
          - oidc_code_missing
          - tenant_not_found
          - constraint_violation
          - sql_exception
          - db_creation_failure
          - db_rename_failure
          - db_status_failure
          - db_initialization_failure
          - db_deletion_failure
          - db_config_missing
          - unauthorized_workspace_access
          - email_send_failure
          - jdbc_exception
          - oidc_exception
          - region_mismatch
          - credential_creation_failure
          - credential_propagation_failure
          - unauthorized_client
          - unsupported_response_type
          - invalid_request
          - server_error
          - access_denied
          - feature_ineligible
          - customer_lookup_failure
          - threshold_exceeded
          - create_rejected
        message:
          minLength: 1
          type: string
        statusCode:
          type: integer
          format: int32
    GetCredentialResponse:
      required:
      - database
      - id
      type: object
      properties:
        id:
          minLength: 1
          type: string
        database:
          $ref: '#/components/schemas/GetDatabaseResponse'
        tenant:
          type: string
        internal:
          type: boolean
        created:
          type: string
          format: date-time
    RotateCredentialRequest:
      type: object
      properties:
        delayOldSecretsExpirationHours:
          maximum: 720
          minimum: 0
          type: number
          format: double
        reason:
          type: string
    CreateCredentialResponse:
      required:
      - database
      - id
      - password
      type: object
      properties:
        id:
          minLength: 1
          type: string
        database:
          $ref: '#/components/schemas/GetDatabaseResponse'
        tenant:
          type: string
        internal:
          type: boolean
        password:
          minLength: 1
          type: string
        created:
          type: string
          format: date-time
  securitySchemes:
    jwtBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- global-openapi.json
- thenile-global-openapi.yml
x-provenance:
  method: harvested
  publisher: Nile
  source: https://global.thenile.dev/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)