find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/aws-backup:aws-backup-restore-jobs-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Aws Backup Restore Jobs API
  version: '2018-11-15'
  description: 'Operations tagged Restore Jobs across 2 of this provider''s published API definitions: aws-backup-openapi.yml, aws-backup-restore-jobs-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://backup.{region}.amazonaws.com
  description: AWS Backup regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
tags:
- name: Restore Jobs
paths:
  /restore-jobs:
    get:
      tags:
      - Restore Jobs
      summary: List restore jobs
      operationId: ListRestoreJobs
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    put:
      tags:
      - Restore Jobs
      summary: Start a restore job
      operationId: StartRestoreJob
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    servers:
    - url: https://backup.{region}.amazonaws.com
      description: AWS Backup regional endpoint
      variables:
        region:
          default: us-east-1
          description: AWS region
  /restore-jobs/{RestoreJobId}:
    get:
      operationId: DescribeRestoreJob
      summary: Describe Restore Job
      description: Returns metadata associated with a restore job that is specified by a job ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeRestoreJobOutput'
        '500':
          description: DependencyFailureException; ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyFailureException'
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeRestoreJobInput'
      tags:
      - Restore Jobs
      security:
      - sigv4: []
    servers:
    - url: https://backup.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /resources/{ResourceArn}/restore-jobs:
    get:
      operationId: ListRestoreJobsByProtectedResource
      summary: List Restore Jobs By Protected Resource
      description: This returns restore jobs that contain the specified protected resource. You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRestoreJobsByProtectedResourceOutput'
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListRestoreJobsByProtectedResourceInput'
      tags:
      - Restore Jobs
      security:
      - sigv4: []
    servers:
    - url: https://backup.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  responses:
    OK:
      description: Successful response
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  requestBodies:
    JsonBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  schemas:
    ServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    InvalidParameterValueException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    RestoreJobsListMember:
      type: object
      properties:
        AccountId:
          type: string
          description: The account ID that owns the restore job.
        RestoreJobId:
          type: string
          description: Uniquely identifies the job that restores a recovery point.
        RecoveryPointArn:
          type: string
          description: An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
        SourceResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.
        BackupVaultArn:
          type: string
          description: The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.
        CreationDate:
          type: string
          format: date-time
          description: The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
        CompletionDate:
          type: string
          format: date-time
          description: The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
        Status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - COMPLETED
          - ABORTED
          - FAILED
          description: A status code specifying the state of the job initiated by Backup to restore a recovery point.
        StatusMessage:
          type: string
          description: A detailed message explaining the status of the job to restore a recovery point.
        PercentDone:
          type: string
          description: Contains an estimated percentage complete of a job at the time the job status was queried.
        BackupSizeInBytes:
          type: integer
          description: The size, in bytes, of the restored resource.
        IamRoleArn:
          type: string
          description: The IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
        ExpectedCompletionTimeMinutes:
          type: integer
          description: The amount of time in minutes that a job restoring a recovery point is expected to take.
        CreatedResourceArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
        ResourceType:
          type: string
          description: The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
        RecoveryPointCreationDate:
          type: string
          format: date-time
          description: The date on which a recovery point was created.
        IsParent:
          type: boolean
          description: This is a boolean value indicating whether the restore job is a parent (composite) restore job.
        ParentJobId:
          type: string
          description: This is the unique identifier of the parent restore job for the selected restore job.
        CreatedBy:
          $ref: '#/components/schemas/RestoreJobCreator'
        ValidationStatus:
          type: string
          enum:
          - FAILED
          - SUCCESSFUL
          - TIMED_OUT
          - VALIDATING
          description: The status of validation run on the indicated restore job.
        ValidationStatusMessage:
          type: string
          description: This describes the status of validation run on the indicated restore job.
        DeletionStatus:
          type: string
          enum:
          - DELETING
          - FAILED
          - SUCCESSFUL
          description: This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.
        DeletionStatusMessage:
          type: string
          description: This describes the restore job deletion status.
    DescribeRestoreJobInput:
      type: object
      properties:
        RestoreJobId:
          type: string
          description: Uniquely identifies the job that restores a recovery point.
      required:
      - RestoreJobId
    DependencyFailureException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    ListRestoreJobsByProtectedResourceInput:
      type: object
      properties:
        ResourceArn:
          type: string
          description: Returns only restore jobs that match the specified resource Amazon Resource Name (ARN).
        ByStatus:
          type: string
          enum:
          - PENDING
          - RUNNING
          - COMPLETED
          - ABORTED
          - FAILED
          description: Returns only restore jobs associated with the specified job status.
        ByRecoveryPointCreationDateAfter:
          type: string
          format: date-time
          description: Returns only restore jobs of recovery points that were created after the specified date.
        ByRecoveryPointCreationDateBefore:
          type: string
          format: date-time
          description: Returns only restore jobs of recovery points that were created before the specified date.
        NextToken:
          type: string
          description: The next item following a partial list of returned items. For example, if a request ismade to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
        MaxResults:
          type: integer
          description: The maximum number of items to be returned.
      required:
      - ResourceArn
    ListRestoreJobsByProtectedResourceOutput:
      type: object
      properties:
        RestoreJobs:
          type: array
          items:
            $ref: '#/components/schemas/RestoreJobsListMember'
          description: An array of objects that contain detailed information about jobs to restore saved resources.>
        NextToken:
          type: string
          description: The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows youto return more items in your list starting at the location pointed to by the next token
    RestoreJobCreator:
      type: object
      properties:
        RestoreTestingPlanArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    DescribeRestoreJobOutput:
      type: object
      properties:
        AccountId:
          type: string
          description: Returns the account ID that owns the restore job.
        RestoreJobId:
          type: string
          description: Uniquely identifies the job that restores a recovery point.
        RecoveryPointArn:
          type: string
          description: An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
        SourceResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.
        BackupVaultArn:
          type: string
          description: The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.
        CreationDate:
          type: string
          format: date-time
          description: The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
        CompletionDate:
          type: string
          format: date-time
          description: The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
        Status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - COMPLETED
          - ABORTED
          - FAILED
          description: Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
        StatusMessage:
          type: string
          description: A message showing the status of a job to restore a recovery point.
        PercentDone:
          type: string
          description: Contains an estimated percentage that is complete of a job at the time the job status was queried.
        BackupSizeInBytes:
          type: integer
          description: The size, in bytes, of the restored resource.
        IamRoleArn:
          type: string
          description: Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
        ExpectedCompletionTimeMinutes:
          type: integer
          description: The amount of time in minutes that a job restoring a recovery point is expected to take.
        CreatedResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource that was created by the restore job. The format of the ARN depends on the resource type of the backed-up resource.
        ResourceType:
          type: string
          description: Returns metadata associated with a restore job listed by resource type.
        RecoveryPointCreationDate:
          type: string
          format: date-time
          description: The creation date of the recovery point made by the specifed restore job.
        CreatedBy:
          $ref: '#/components/schemas/RestoreJobCreator'
        ValidationStatus:
          type: string
          enum:
          - FAILED
          - SUCCESSFUL
          - TIMED_OUT
          - VALIDATING
          description: The status of validation run on the indicated restore job.
        ValidationStatusMessage:
          type: string
          description: The status message.
        DeletionStatus:
          type: string
          enum:
          - DELETING
          - FAILED
          - SUCCESSFUL
          description: The status of the data generated by the restore test.
        DeletionStatusMessage:
          type: string
          description: This describes the restore job deletion status.
        IsParent:
          type: boolean
          description: This is a boolean value indicating whether the restore job is a parent (composite) restore job.
        ParentJobId:
          type: string
          description: This is the unique identifier of the parent restore job for the selected restore job.
  securitySchemes:
    SigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed Authorization header
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: backup
x-refined-from:
- aws-backup-openapi.yml
- aws-backup-restore-jobs-api-openapi.yml