Sandbox Test

Test sandbox creation

post

Create a single sandbox for testing purposes

Body

devHubUsernamestringRequired

DevHub username

Example: [email protected]

sandboxNamestringRequired

Sandbox name (alphanumeric only)

Example: 123456

licenseTypestringOptional

License type

Example: Developer

descriptionstringOptional

Description

Example: Test sandbox

autoActivatebooleanOptional

Auto activate

Example: true

Responses

201

Sandbox creation initiated

application/json

post

HTTPcURLJavaScriptPython

POST /sfp/api/sandbox/test/create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "devHubUsername": "[email protected]",
  "sandboxName": "123456",
  "licenseType": "Developer",
  "description": "Test sandbox",
  "autoActivate": true
}

201

Sandbox creation initiated

{
  "success": true,
  "sandboxName": "text",
  "result": {},
  "error": "text"
}

Check sandbox status

get

Get the current status of a sandbox

Path parameters

sandboxNamestringRequired

Name of the sandbox

Query parameters

devHubUsernamestringRequired

DevHub username

Responses

200

Sandbox status

application/json

get

HTTPcURLJavaScriptPython

GET /sfp/api/sandbox/test/status/{sandboxName}?devHubUsername=text HTTP/1.1
Host: 
Accept: */*

200

Sandbox status

{
  "sandboxName": "text",
  "status": "text",
  "details": {},
  "error": "text"
}

List sandboxes

get

List all sandboxes in a DevHub

Query parameters

devHubUsernamestringRequired

DevHub username

Responses

200

Sandbox list

application/json

get

HTTPcURLJavaScriptPython

GET /sfp/api/sandbox/test/list?devHubUsername=text HTTP/1.1
Host: 
Accept: */*

200

Sandbox list

{
  "count": 1,
  "sandboxes": [
    {
      "SandboxName": "text",
      "Status": "text",
      "Id": "text",
      "CreatedDate": "text"
    }
  ]
}

Test Salesforce API directly

post

Make a direct API call to test connectivity and permissions

Body

devHubUsernamestringOptional

querystringOptionalExample: SELECT Id, Name FROM SandboxProcess LIMIT 1

Responses

201Success

post

HTTPcURLJavaScriptPython

POST /sfp/api/sandbox/test/api-test HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "devHubUsername": "text",
  "query": "SELECT Id, Name FROM SandboxProcess LIMIT 1"
}

201Success

No content