Skip to content
v2 API/
/
Get list of all folders

V2 API

Download OpenAPI description
SCALA-API.openapi.json
SCALA-API.openapi.yaml
Languages
Servers
https://api.observepoint.com/v2/

Rules

Endpoints for managing rules including creation, configuration, assignment, and rule-based validation logic

Operations

Labels

Endpoints for managing labels including creation, assignment, and retrieval for organizing audits, journeys, and other resources

Operations

Audits

Endpoints for managing audits including creation, configuration, execution, and retrieving audit results and runs

Operations

Manual Journeys

Endpoints for managing manual journeys including real device testing, HAR file ingestion, and journey execution control. These endpoints power Live Connect and HAR Analyzer features in the ObservePoint UI, enabling users to perform manual testing on real devices and analyze HAR files for tag validation and troubleshooting.

For more information, see the HAR File Processing API Recipe.

Operations

Tags

Endpoints for managing tags and tag-related operations including tag metadata and configuration

Operations

Account

Endpoints for managing account settings, configurations, and account-level information

Operations

Folders

Endpoints for managing folders including creation, organization, access control, and folder-based resource management

Operations

Get list of all folders

Request

GET /v2/folders
Security
API_Key
curl -i -X GET \
  https://api.observepoint.com/v2/folders \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
accountIdinteger(int32)required
appFailuresinteger(int32)required
appRuleFailuresinteger(int32)required
appsCountinteger(int32)required
appsInQueueinteger(int32)required
appsRunninginteger(int32)required
auditsRunninginteger(int32)required
createdAtstring(date-time)required
createdByUserIdinteger(int32)required
createdByUserNamestringrequired
domainsCountinteger(int32)required
idinteger(int32)required
namestringrequired
simulationErrorsinteger(int32)required
simulationsRunninginteger(int32)required
]
Response
application/json
[
  {
    "accountId": 0,
    "appFailures": 0,
    "appRuleFailures": 0,
    "appsCount": 0,
    "appsInQueue": 0,
    "appsRunning": 0,
    "auditsRunning": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "createdByUserId": 0,
    "createdByUserName": "string",
    "domainsCount": 0,
    "id": 0,
    "name": "string",
    "simulationErrors": 0,
    "simulationsRunning": 0
  }
]

Create new folder

Request

POST /v2/folders
Security
API_Key
Bodyapplication/jsonrequired

Folder create information

namestringrequired
curl -i -X POST \
  https://api.observepoint.com/v2/folders \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
appFailuresinteger(int32)required
appRuleFailuresinteger(int32)required
appsCountinteger(int32)required
appsInQueueinteger(int32)required
appsRunninginteger(int32)required
auditsRunninginteger(int32)required
createdAtstring(date-time)required
createdByUserIdinteger(int32)required
createdByUserNamestringrequired
domainsCountinteger(int32)required
idinteger(int32)required
namestringrequired
simulationErrorsinteger(int32)required
simulationsRunninginteger(int32)required
Response
application/json
{
  "accountId": 0,
  "appFailures": 0,
  "appRuleFailures": 0,
  "appsCount": 0,
  "appsInQueue": 0,
  "appsRunning": 0,
  "auditsRunning": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByUserId": 0,
  "createdByUserName": "string",
  "domainsCount": 0,
  "id": 0,
  "name": "string",
  "simulationErrors": 0,
  "simulationsRunning": 0
}

Get folder by given id

Request

GET /v2/folders/{folderId}
Security
API_Key
Path
folderIdinteger(int32)required
curl -i -X GET \
  'https://api.observepoint.com/v2/folders/{folderId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
appFailuresinteger(int32)required
appRuleFailuresinteger(int32)required
appsCountinteger(int32)required
appsInQueueinteger(int32)required
appsRunninginteger(int32)required
auditsRunninginteger(int32)required
createdAtstring(date-time)required
createdByUserIdinteger(int32)required
createdByUserNamestringrequired
domainsCountinteger(int32)required
idinteger(int32)required
namestringrequired
simulationErrorsinteger(int32)required
simulationsRunninginteger(int32)required
Response
application/json
{
  "accountId": 0,
  "appFailures": 0,
  "appRuleFailures": 0,
  "appsCount": 0,
  "appsInQueue": 0,
  "appsRunning": 0,
  "auditsRunning": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByUserId": 0,
  "createdByUserName": "string",
  "domainsCount": 0,
  "id": 0,
  "name": "string",
  "simulationErrors": 0,
  "simulationsRunning": 0
}

Update folder with given id

Request

PUT /v2/folders/{folderId}
Security
API_Key
Path
folderIdinteger(int32)required
Bodyapplication/jsonrequired

Folder update information

namestringrequired
curl -i -X PUT \
  'https://api.observepoint.com/v2/folders/{folderId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger(int32)required
appFailuresinteger(int32)required
appRuleFailuresinteger(int32)required
appsCountinteger(int32)required
appsInQueueinteger(int32)required
appsRunninginteger(int32)required
auditsRunninginteger(int32)required
createdAtstring(date-time)required
createdByUserIdinteger(int32)required
createdByUserNamestringrequired
domainsCountinteger(int32)required
idinteger(int32)required
namestringrequired
simulationErrorsinteger(int32)required
simulationsRunninginteger(int32)required
Response
application/json
{
  "accountId": 0,
  "appFailures": 0,
  "appRuleFailures": 0,
  "appsCount": 0,
  "appsInQueue": 0,
  "appsRunning": 0,
  "auditsRunning": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByUserId": 0,
  "createdByUserName": "string",
  "domainsCount": 0,
  "id": 0,
  "name": "string",
  "simulationErrors": 0,
  "simulationsRunning": 0
}

Delete folder with given id

Request

DELETE /v2/folders/{folderId}
Security
API_Key
Path
folderIdinteger(int32)required
curl -i -X DELETE \
  'https://api.observepoint.com/v2/folders/{folderId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Item was successfully deleted

Response
No content

Get users of folder with given id

Request

GET /v2/folders/{folderId}/users
Security
API_Key
Path
folderIdinteger(int32)required
curl -i -X GET \
  'https://api.observepoint.com/v2/folders/{folderId}/users' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
accountIdinteger(int32)required
createdstring(date-time)required
deletedstring

ISO 8601 date time string with offset when user was deleted, null if not deleted

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessbooleanrequired
idinteger(int32)required
lastLoginstring(date-time)
lastNamestringrequired
maxPagesPerAuditinteger(int32)required
permissionsstring
Enum"guest""user""admin"
timezonestringrequired
updatedstring(date-time)required
usernamestringrequired
]
Response
application/json
[
  {
    "accountId": 0,
    "created": "2019-08-24T14:15:22Z",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "fullUsageDashboardAccess": true,
    "id": 0,
    "lastLogin": "2019-08-24T14:15:22Z",
    "lastName": "string",
    "maxPagesPerAudit": 0,
    "permissions": "guest",
    "timezone": "string",
    "updated": "2019-08-24T14:15:22Z",
    "username": "string"
  }
]

Add users to folder with given id

Request

POST /v2/folders/{folderId}/users
Security
API_Key
Path
folderIdinteger(int32)required
Bodyapplication/jsonrequired

List of users ids

Array [
integer(int32)
]
curl -i -X POST \
  'https://api.observepoint.com/v2/folders/{folderId}/users' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    0
  ]'

Responses

successful operation

Bodyapplication/jsonArray [
accountIdinteger(int32)required
createdstring(date-time)required
deletedstring

ISO 8601 date time string with offset when user was deleted, null if not deleted

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessbooleanrequired
idinteger(int32)required
lastLoginstring(date-time)
lastNamestringrequired
maxPagesPerAuditinteger(int32)required
permissionsstring
Enum"guest""user""admin"
timezonestringrequired
updatedstring(date-time)required
usernamestringrequired
]
Response
application/json
[
  {
    "accountId": 0,
    "created": "2019-08-24T14:15:22Z",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "fullUsageDashboardAccess": true,
    "id": 0,
    "lastLogin": "2019-08-24T14:15:22Z",
    "lastName": "string",
    "maxPagesPerAudit": 0,
    "permissions": "guest",
    "timezone": "string",
    "updated": "2019-08-24T14:15:22Z",
    "username": "string"
  }
]

Users

Endpoints for managing users including creation, authentication, permissions, and user account management

Operations

Sub-Folders

Endpoints for managing sub-folders including creation, configuration, and sub-folder-based audit and journey management

Operations