Source inspections

Download schema

Endpoints to test the source of a backup job on its server before saving it. The agent checks it can read the directories, or sign in to the database and list the selected databases and tables.

Test a backup source

POST

https://backup.chief.app/api/v1

/source-inspections

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Ask the agent of a server to test a backup source. The agent runs the test the next time it checks in, usually within a minute: poll the inspection until it completed, then pass its ID as source_inspection when creating the job, or when changing the source of a job (test with the job argument), within 10 minutes. The tested source must match the saved source exactly.

Test a backup source › Request Body

Validates a source to test, for a new backup job on a server or for a change to an existing job.

InspectSourceRequest

object · required

What to back up. The fields depend on the type, see the description of each field. Fields left out keep their value on an existing job.

job

string

Formatted ID of the backup job whose source changes. The source fields left out keep the job's value, including its stored database password. Leave it out to test the source of a new job.

Example: job_01j8q8zk2f4m6n7p9r1s3t5v7x

server

string

Formatted ID of the enrolled server that tests the source of a new job.

Example: server_01j8q8zk2f4m6n7p9r1s3t5v7x

type

string · enum

The type of the new job.

Enum values:

file

mysql

postgresql

Test a backup source › Responses

The test was queued.

SourceInspection · required

POST/source-inspections

curl https://backup.chief.app/api/v1/source-inspections \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "job": "job_01j8q8zk2f4m6n7p9r1s3t5v7x",
  "server": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
  "type": "file",
  "source": {
    "paths": [
      "string"
    ],
    "excludes": [
      "*.log",
      "storage/cache"
    ],
    "host": "127.0.0.1",
    "port": 3306,
    "username": "username",
    "password": "password",
    "password_file": "password_file",
    "no_password": true,
    "connection_database": "connection_database",
    "selection_mode": "all_accessible",
    "databases": [
      "string"
    ],
    "include_routines": true,
    "include_events": true,
    "custom_flags": [
      "--hex-blob"
    ],
    "table_selection": {
      "mode": "all",
      "tables": [
        {
          "database": "database",
          "schema": "schema",
          "table": "table"
        }
      ]
    }
  }
}'

Example Request Body

{
  "job": "job_01j8q8zk2f4m6n7p9r1s3t5v7x",
  "server": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
  "type": "file",
  "source": {
    "paths": [
      "string"
    ],
    "excludes": [
      "*.log",
      "storage/cache"
    ],
    "host": "127.0.0.1",
    "port": 3306,
    "username": "username",
    "password": "password",
    "password_file": "password_file",
    "no_password": true,
    "connection_database": "connection_database",
    "selection_mode": "all_accessible",
    "databases": [
      "string"
    ],
    "include_routines": true,
    "include_events": true,
    "custom_flags": [
      "--hex-blob"
    ],
    "table_selection": {
      "mode": "all",
      "tables": [
        {
          "database": "database",
          "schema": "schema",
          "table": "table"
        }
      ]
    }
  }
}

json

Example Responses

{
  "data": {
    "id": "inspection_01j8q8zk2f4m6n7p9r1s3t5v7x",
    "server": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "name"
    },
    "status": "pending",
    "successful": true,
    "result": {
      "code": "success",
      "summary": "Synthetic directory access verified.",
      "databases": [
        "string"
      ]
    },
    "guidance": {
      "stage": "source_validation",
      "action": "action",
      "detail": "detail"
    },
    "expires_at": "expires_at",
    "completed_at": "completed_at",
    "created_at": "created_at"
  }
}

json

application/json

Get a source inspection

GET

https://backup.chief.app/api/v1

/source-inspections/{inspection}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Poll a source test until it completed. successful tells whether the source can be saved; guidance explains how to fix a failed test.

Get a source inspection › path Parameters

inspection

string · required

Get a source inspection › Responses

SourceInspection

SourceInspection · required

Backup jobs Runs