Tessell Availability Machine API

openapi: 3.2.0
info:
  title: Tessell APIs activity-center Availability Machine API
  contact:
    email: support@tessell.com
    name: Tessell Inc
    url: https://www.tessell.com
  description: Tessell API Documentation
  termsOfService: https://www.tessell.com/terms
  version: '1.0'
servers:
- url: '{server}'
  variables:
    server:
      default: console.tessell.com
tags:
- name: Availability Machine
paths:
  /availability-machines:
    get:
      tags:
      - Availability Machine
      summary: Get a list of Availability Machines
      operationId: getAvailabilityMachines
      x-terraform-resource: AvailabilityMachine
      x-terraform-operation: ReadList
      x-terraform:
        excludeParamsFromApiDefinition:
        - pageSize
        - pageOffset
        - timeZone
      parameters:
      - name: name
        in: query
        description: Filter the result based on Availability Machine name
        required: false
        style: form
        schema:
          type: string
      - name: status
        in: query
        description: Filter the result based on Availability Machine status
        required: false
        style: form
        schema:
          type: string
      - name: engine-type
        in: query
        description: Filter the result based on Availability Machine's database engine-type
        required: false
        style: form
        schema:
          type: string
      - name: load-daps
        in: query
        description: Boolean to indicate if AM's DAPs to be fetched or not
        schema:
          type: boolean
          default: true
      - name: load-rpo-policy
        description: Load RPO policy configuration associated with the Availability Machine
        in: query
        style: form
        schema:
          type: boolean
          default: false
      - name: load-storage-config
        description: Load storage details of the corresponding DB Service
        in: query
        style: form
        schema:
          type: boolean
          default: false
      - $ref: '#/components/parameters/loadAcls'
      - $ref: '#/components/parameters/owners'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/timeZone'
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDmmsServiceView'
              examples:
                generic:
                  $ref: '#/components/examples/GetAvailabilityMachines'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /availability-machines/{id}:
    get:
      tags:
      - Availability Machine
      summary: Get details about an Availability Machine
      operationId: getAvailabilityMachine
      x-terraform-resource: AvailabilityMachine
      x-terraform-operation: Read
      x-terraform:
        excludeParamsFromApiDefinition:
        - loadAcls
        - timeZone
      parameters:
      - name: id
        in: path
        description: ID of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: load-daps
        in: query
        description: Boolean to indicate if AM's DAPs to be fetched or not
        schema:
          type: boolean
          default: true
      - name: load-rpo-policy
        description: Load RPO policy configuration associated with the Availability Machine
        in: query
        style: form
        schema:
          type: boolean
          default: true
      - name: load-storage-config
        description: Load storage details of the corresponding DB Service
        in: query
        style: form
        schema:
          type: boolean
          default: true
      - name: load-clones
        description: Load cloned DB Services details created using Availability Machine
        in: query
        style: form
        schema:
          type: boolean
          default: true
      - $ref: '#/components/parameters/loadAcls'
      - $ref: '#/components/parameters/timeZone'
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DmmConsumerView'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    delete:
      tags:
      - Availability Machine
      summary: Delete the Availability Machine and the associated data (if any) including snapshots, sanitized-snapshots, and backups.
      operationId: deleteAvailabilityMachine
      parameters:
      - name: id
        in: path
        description: ID of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiStatus'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /availability-machines/{id}/pause:
    patch:
      tags:
      - Availability Machine
      summary: Pause the automated backups for a Availability Machine
      operationId: pauseAvailabilityMachine
      parameters:
      - name: id
        in: path
        description: Id of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PauseTessellDmmPayload'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiStatus'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /availability-machines/{id}/backup-download-config:
    patch:
      tags:
      - Availability Machine
      summary: Allow backup download for a Availability Machine
      operationId: updateBackupDownloadConfig
      parameters:
      - name: id
        in: path
        description: Id of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBackupDownloadConfigPayload'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupDownloadConfig'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /availability-machines/{id}/resume:
    patch:
      tags:
      - Availability Machine
      summary: Resume the automated backups for a Availability Machine
      operationId: resumeAvailabilityMachine
      parameters:
      - name: id
        in: path
        description: Id of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResumeTessellDmmPayload'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiStatus'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /availability-machines/{id}/acls:
    get:
      tags:
      - Availability Machine
      summary: Get list of ACLs for an Availability Machine
      operationId: getAvailabilityMachineAcls
      parameters:
      - name: id
        in: path
        description: ID of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityAclSharingInfo'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    patch:
      tags:
      - Availability Machine
      summary: Create or update ACLs for an Availability Machine
      operationId: createAvailabilityMachineAcls
      parameters:
      - name: id
        in: path
        description: ID of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AclPayload'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AclPayload'
        '204':
          description: No Content
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    delete:
      tags:
      - Availability Machine
      summary: Revoke ACLs for an Availability Machine
      operationId: revokeAvailabilityMachineAcls
      parameters:
      - name: id
        in: path
        description: ID of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AclRevokePayload'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiStatus'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /availability-machines/{id}/acls/eligible-users:
    get:
      tags:
      - Availability Machine
      summary: Get list of users which are eligible to grant access for an Availability Machine
      operationId: getEligibleUsersForAvailabilityMachine
      parameters:
      - name: id
        in: path
        description: ID of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: roles
        in: query
        description: Filter the result based on specified roles
        required: false
        style: form
        schema:
          type: array
          items:
            type: string
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AclEligibleUser'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /dataflix/{id}/catalog/backups/{backup-id}/download-url:
    get:
      tags:
      - Availability Machine
      summary: Get download url info for the backup
      operationId: getDownloadUrlInfo
      parameters:
      - name: id
        in: path
        description: Id of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: backup-id
        in: path
        description: ID of the backup
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataflixDownloadUrlInfo'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /dataflix/{id}/acls/eligible-users:
    get:
      tags:
      - Availability Machine
      summary: Get list of all the users by privileges
      operationId: getEligibleUsersForDataflix
      parameters:
      - name: id
        in: path
        description: Id of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - name: roles
        in: query
        description: roles
        required: false
        style: form
        schema:
          type: array
          items:
            type: string
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AclEligibleUser'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /availability-machines/{id}/size:
    get:
      tags:
      - Availability Machine
      summary: Get size consumption details for Tessell Data Management Machine
      operationId: getAvailabilityMachineSize
      parameters:
      - name: id
        in: path
        description: Id of the Availability Machine
        required: true
        style: simple
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/timeZone'
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TessellDmmSizeDTO'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    DatesForEachMonth:
      type: object
      properties:
        dates:
          description: Dates in a month to retain monthly backups
          uniqueItems: true
          type: array
          items:
            type: integer
            format: int32
            minimum: 1
            maximum: 31
        lastDayOfMonth:
          type: boolean
          default: false
    DBServiceTopology:
      title: DBServiceTopology
      type: object
      properties:
        type:
          $ref: '#/components/schemas/TessellServiceInstanceType'
        cloudType:
          $ref: '#/components/schemas/cloudType'
        region:
          type: string
        availabilityZones:
          type: array
          items:
            type: string
    AclEligibleUser:
      title: AclEligibleUser
      description: Eligible user for sharing the entity
      properties:
        firstName:
          type: string
        lastName:
          type: string
        emailId:
          type: string
        eligibleRoles:
          type: array
          items:
            type: string
        accessibleSubscriptions:
          type: array
          items:
            type: string
          description: List of subscriptions user has access to
    RegionToEncryptionKey:
      type: object
      required:
      - region
      properties:
        region:
          type: string
        encryptionKeyName:
          type: string
    PrivateLinkInfo:
      title: PrivateLinkInfo
      allOf:
      - $ref: '#/components/schemas/PrivateLinkPayload'
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/PrivateLinkStatus'
        endpointServiceName:
          description: The configured endpoint as a result of configuring the service-principals
          type: string
          x-computed: true
        privateLinkServiceAlias:
          type: string
          description: The Azure private link service alias
    PrivateLinkPayload:
      type: object
      description: The interface endpoint or Gateway Load Balancer endpoint to connect to your DB service.
      properties:
        servicePrincipals:
          description: The list of AWS account principals that are currently enabled. This is only applicable for DB Services hosted on AWS.
          uniqueItems: true
          type: array
          items:
            type: string
        clientAzureSubscriptionIds:
          description: The list of Azure subscription Ids. This is only applicable for DB Services hosted on AZURE.
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
    InstanceStorageConfig:
      type: object
      properties:
        provider:
          $ref: '#/components/schemas/StorageProviderType'
        volumeType:
          type: string
          description: Data disk volume type
        fsxNetAppConfig:
          $ref: '#/components/schemas/InstanceFsxNetAppConfig'
        azureNetAppConfig:
          $ref: '#/components/schemas/InstanceAzureNetAppConfig'
    ServiceInstanceEngineInfo:
      title: TessellServiceInstanceInfo
      description: This field details the DB Service Instance engine configuration details like - access mode
      type:
      - object
      - 'null'
      properties:
        oracleConfig:
          $ref: '#/components/schemas/ServiceInstanceOracleEngineConfig'
    ComputeProviderType:
      type: string
      enum:
      - AWS_EC2
      - AZURE_VM
      - GCP_GCE
      - OCI_EXADATA
      - AZURE_EXADATA
      - AWS_EXADATA
    DmmConsumerView:
      type: object
      description: The Availability Machine is an abstraction provided by Tessell that takes care of all of the data-management and data-protection aspects for a DB Service, like capturing snapshots, backups, providing PITR recoverability, and processing the data for sanitization.
      x-terraform-resource: AvailabilityMachine
      x-terraform:
        plural-name: AvailabilityMachines
        render:
        - data_source
        - data_source_list
      properties:
        id:
          type: string
          format: uuid
          description: ID of the Availability Machine
        tessellServiceId:
          type: string
          format: uuid
          description: ID of the DB Service that is associated with the Availability Machine
        serviceName:
          type: string
          description: Name of the DB Service that is associated with the Availability Machine
        tenant:
          type: string
          description: ID of the tenant under which this Availability Machine is effective
        subscription:
          type: string
          description: Name of the subscription under which the associated DB Service is hosted
        engineType:
          x-enum: true
          $ref: '#/components/schemas/databaseEngineType'
          description: Engine type for the associated DB Service
        dataIngestionStatus:
          x-enum: true
          $ref: '#/components/schemas/AmDataIngestionStatus'
          description: Status for the associated DB Service
        userId:
          type: string
          description: User details representing the owner for the Availability Machine
        owner:
          type: string
          description: User details representing the owner for the Availability Machine
        loggedInUserRole:
          type: string
          description: The role of the logged in user for accessing this Availability Machine
        sharedWith:
          description: List of users having access to the Availability Machine
          $ref: '#/components/schemas/EntityAclSharingInfo'
        cloudAvailability:
          type: array
          items:
            $ref: '#/components/schemas/CloudRegionInfo'
          description: Availability Machine manages data across multiple regions within a cloud. This sections provides information about the cloud and regions where this Availability Machine is managing the data.
        topology:
          description: 'The availability location details: cloudAccount to region'
          type: array
          items:
            $ref: '#/components/schemas/DBServiceTopology'
        rpoPolicy:
          $ref: '#/components/schemas/RpoPolicyConfig'
        daps:
          type: array
          items:
            $ref: '#/components/schemas/TessellDapServiceDTO'
          description: The Access Policies (DAP) that have configured for this Availability Machine
        clones:
          type: array
          items:
            $ref: '#/components/schemas/TessellCloneSummaryInfo'
          description: The clone DB Services that have been created using contents (snapshots, Sanitized Snapshots, PITR, backups) from this Availability Machine
        dateCreated:
          type: string
          format: date-time
          description: The timestamp when the Availability Machine was incarnated
        dateModified:
          type: string
          format: date-time
          description: The timestamp when the Availability Machine was last updated
        tsm:
          type: boolean
          default: false
          description: Specify whether the associated DB Service is created using TSM compute type
        backupDownloadConfig:
          $ref: '#/components/schemas/BackupDownloadConfig'
          description: Backup download config for the service (deprecated)
        storageConfig:
          $ref: '#/components/schemas/StorageConfigPayload'
    DbBackupStatus:
      description: DB Backup Status
      type: string
      enum:
      - AVAILABLE
      - CREATING
      - SOFT_DELETED
      - DELETED
      - DELETING
      - QUEUED
      - SCHEDULED
      - REPLICATING
      - DELETED_FOR_USER
      - DELETED_FOR_SLA
      - DELETION_FAILED
      - FAILED
      - PREPARING
      - REPLICATION_FAILED
    databaseEngineType:
      description: Database Engine Type
      type: string
      enum:
      - ORACLE
      - POSTGRESQL
      - SQLSERVER
      - MYSQL
      - APACHE_KAFKA
      - MONGODB
      - MILVUS
    TessellServiceInstanceRole:
      type: string
      description: DB Service instance role
      enum:
      - primary
      - read_only_replica
      - failover_replica
      - dr
    BackupCustomRpoPolicy:
      description: This is the definition of Custom RPO Policy for Backup for Tessell DB Service
      allOf:
      - $ref: '#/components/schemas/CustomRpoPolicy'
    DailySchedule:
      type: object
      properties:
        backupsPerDay:
          type: integer
          format: int32
          description: The number of backups to be captured per day.
          minimum: 0
    WeeklySchedule:
      type: object
      properties:
        days:
          description: Days in a week to retain weekly backups for
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/WeekDay'
            x-enum: true
    TessellServiceInstanceDTO:
      title: TessellServiceInstanceDTO
      type: object
      description: This is a definition of the DB Service Instance object
      required:
      - name
      properties:
        id:
          type: string
          format: uuid
          description: Tessell generated UUID for the DB Service Instance
          x-computed: true
        name:
          type: string
          description: Name of the DB Service Instance
        instanceGroupName:
          type: string
          description: Name of the instance group
        type:
          $ref: '#/components/schemas/TessellServiceInstanceType'
          x-computed: true
          x-enum: true
        role:
          description: DB Service Topology
          $ref: '#/components/schemas/TessellServiceInstanceRole'
          x-computed: true
          x-enum: true
        status:
          $ref: '#/components/schemas/TessellServiceInstanceStatus'
          x-computed: true
          x-enum: true
        tessellServiceId:
          description: DB Service Instance's associated DB Service id
          type: string
          format: uuid
          x-computed: true
        cloud:
          description: DB Service Instance's cloud type
          type: string
          x-computed: true
        region:
          description: DB Service Instance's cloud region
          type: string
          x-computed: true
        availabilityZone:
          x-computed: true
          description: DB Service Instance's cloud availability zone
          type: string
        availabilitySet:
          type: string
          description: The availability set to which the Compute Resource belongs
          minLength: 1
          maxLength: 80
          x-computed: true
        instanceGroupId:
          description: The instance groupd Id
          type: string
          format: uuid
          x-computed: true
        computeType:
          description: The compute used for creation of the Tessell Service Instance
          type: string
          x-computed: true
        awsInfraConfig:
          $ref: '#/components/schemas/AwsInfraConfig'
          x-computed: true
        gcpInfraConfig:
          $ref: '#/components/schemas/GcpInfraConfig'
          x-computed: true
        computeId:
          description: The associated compute identifier
          type: string
          format: uuid
          x-computed: true
        computeName:
          description: The associated compute name
          type: string
        storage:
          description: The storage (in bytes) that has been provisioned for the DB Service instance.
          type: integer
          format: int64
          minimum: 0
          x-computed: true
        dataVolumeIops:
          type: integer
          format: int32
          x-computed: true
        throughput:
          type: integer
          format: int32
          description: Throughput requested for this DB Service instance
          x-computed: true
        enablePerfInsights:
          type: boolean
          x-computed: true
        parameterProfile:
          $ref: '#/components/schemas/ParameterProfile'
          x-computed: true
        optionProfile:
          $ref: '#/components/schemas/OptionProfile'
          x-computed: true
        monitoringConfig:
          $ref: '#/components/schemas/MonitoringConfig'
          x-computed: true
        vpc:
          type: string
          description: The VPC used for creation of the DB Service Instance
          x-computed: true
        publicSubnet:
          type: string
          description: The public subnet used for creation of the DB Service Instance
          x-computed: true
        privateSubnet:
          type: string
          description: The private subnet used for creation of the DB Service Instance
          x-computed: true
        encryptionKey:
          type: string
          description: The encryption key name which is used to encrypt the data at rest
          x-computed: true
        softwareImage:
          type: string
          description: Software Image to be used to create the instance
          x-computed: true
        softwareImageVersion:
          type: string
          description: Software Image Version to be used to create the instance
          x-computed: true
        dateCreated:
          type: string
          description: Timestamp when the entity was created
          format: date-time
          x-computed: true
        connectString:
          $ref: '#/components/schemas/TessellServiceInstanceConnectString'
          x-computed: true
        updatesInProgress:
          description: The updates that are in progress for this resource
          type: array
          x-computed: true
          items:
            $ref: '#/components/schemas/TessellResourceUpdateInfo'
        lastStartedAt:
          description: Timestamp when the service instance was last started at
          type: string
          format: date-time
          x-computed: true
        lastStoppedAt:
          description: Timestamp when the Service Instance was last stopped at
          type: string
          format: date-time
          x-computed: true
        syncMode:
          $ref: '#/components/schemas/InstanceSyncMode'
          x-computed: true
        engineConfiguration:
          $ref: '#/components/schemas/ServiceInstanceEngineInfo'
          x-computed: true
        computeConfig:
          $ref: '#/components/schemas/InstanceComputeConfig'
        storageConfig:
          $ref: '#/components/schemas/InstanceStorageConfig'
        archiveStorageConfig:
          $ref: '#/components/schemas/InstanceStorageConfig'
        privateLinkInfo:
          $ref: '#/components/schemas/PrivateLinkInfo'
        securityConfig:
          $ref: '#/components/schemas/SecurityConfigOps'
        contextInfo:
          $ref: '#/components/schemas/TessellServiceInstanceContextInfo'
    TimeFormat:
      title: TimeFormat
      description: Clock time format value in hour and minute.
      type: object
      required:
      - hour
      - minute
      properties:
        hour:
          type: integer
          format: int32
          minimum: 0
          maximum: 23
          default: 1
        minute:
          type: integer
          format: int32
          minimum: 0
          maximum: 59
          default: 0
    AclUserPayload:
      title: AclUserPayload
      description: Payload to create an user's entity ACL
      required:
      - emailId
      - role
      properties:
        emai

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tessell/refs/heads/main/openapi/tessell-availability-machine-api-openapi.yml