Connection settings

Get Connection settings

get

Returns the Connection settings containing information about API quota, Backup & Archive Connection, and scheduler activity

Authorizations

AuthorizationstringRequired

Bearer <access_token>

Path parameters

connectionIdnumberRequired

Responses

200

Returns the Connection settings

application/json

initialBinaryRecordsLimitnumberRequired

400

Incorrect request data is provided. For example, connectionId isn't a valid number

application/json

404

Connection settings not found

application/json

get/api/v1/connections/{connectionId}/settings

GET /api/v1/connections/{connectionId}/settings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "apiQuota": {
    "rest": 80,
    "bulk": 80
  },
  "info": {
    "id": 1,
    "name": "MyOrg",
    "userName": "[e-mail]",
    "salesforceOrgId": "12ABC34567892DEFGC",
    "salesforceOrgType": "PRODUCTION"
  },
  "scheduler": {
    "isBackupsDisabled": true,
    "isArchivesDisabled": true
  },
  "initialBinaryRecordsLimit": 1
}

Update connection scheduler availability settings

put

Updates scheduler availability for backup and archive operations for the specified connection, including optional initial binary records limit configuration.

Authorizations

AuthorizationstringRequired

Bearer <access_token>

Path parameters

connectionIdnumberRequired

Body

isBackupsDisabledbooleanRequired

isArchivesDisabledbooleanRequired

initialBinaryRecordsLimitnumberRequiredExample: 5000

Responses

200

The connection's scheduler run capability was updated.

application/json

messagestringRequired

put/api/v1/connections/{connectionId}/settings

PUT /api/v1/connections/{connectionId}/settings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "isBackupsDisabled": true,
  "isArchivesDisabled": true,
  "initialBinaryRecordsLimit": 5000
}

200

The connection's scheduler run capability was updated.

{
  "message": "text"
}