Synthetics

Synthetics

get

Returns of all synthetics

Path parameters

orgUidstringRequired

orgID (UUID)

Query parameters

environmentIdinteger · int64Optional

EnvironmentID

activatedbooleanOptional

Activated

tokenstringRequired

Token authentication

Responses

200

OK

application/json

400

Bad Request

application/json

get

/{orgUid}/synthetics/v1

HTTPcURLJavaScriptPython

GET /{orgUid}/synthetics/v1?token=text HTTP/1.1
Host: apis.elven.works
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Synthetics

post

Create synthetics

Path parameters

orgUidstringRequired

orgID (UUID)

Query parameters

tokenstringRequired

Token authentication

Body

application/json

activatedbooleanOptional

environment_idintegerRequired

intervalintegerRequired

namestringRequired

org_uidstringRequired

originstring · enumRequiredPossible values:

uidstringOptional

Responses

200

OK

application/json

400

Bad Request

application/json

post

/{orgUid}/synthetics/v1

HTTPcURLJavaScriptPython

POST /{orgUid}/synthetics/v1?token=text HTTP/1.1
Host: apis.elven.works
Content-Type: application/json
Accept: */*
Content-Length: 364

{
  "activated": true,
  "environment_id": 1,
  "interval": 1,
  "name": "text",
  "org_uid": "text",
  "origin": "agent",
  "steps": [
    {
      "assertions": [
        {
          "comparison": "text",
          "order": 1,
          "property": "text",
          "source": "text",
          "target_value": "text"
        }
      ],
      "domain": "text",
      "domain_settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "method": "text",
      "name": "text",
      "step": 1,
      "timeout": 1,
      "type": "text"
    }
  ],
  "uid": "text"
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Synthetics

put

Returns Synthetics

Path parameters

orgUidstringRequired

orgID (UUID)

Query parameters

tokenstringRequired

Token authentication

Body

application/json

environment_idintegerRequired

idintegerOptional

intervalintegerRequired

namestringRequired

org_uidstringRequired

originstring · enumRequiredPossible values:

statusstringOptional

uidstringOptional

Responses

200

OK

application/json

400

Bad Request

application/json

put

/{orgUid}/synthetics/v1

HTTPcURLJavaScriptPython

PUT /{orgUid}/synthetics/v1?token=text HTTP/1.1
Host: apis.elven.works
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "environment_id": 1,
  "id": 1,
  "interval": 1,
  "name": "text",
  "org_uid": "text",
  "origin": "agent",
  "status": "text",
  "steps": [
    {
      "assertions": [
        {
          "comparison": "text",
          "id": 1,
          "order": 1,
          "property": "text",
          "source": "text",
          "step_id": 1,
          "target_value": "text"
        }
      ],
      "domain": "text",
      "domain_settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": 1,
      "method": "text",
      "name": "text",
      "step": 1,
      "timeout": 1,
      "type": "text"
    }
  ],
  "uid": "text"
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Synthetics

get

Returns Synthetics by Uid

Path parameters

orgUidstringRequired

orgUid

uidstringRequired

uid

Query parameters

tokenstringRequired

Token authentication

Responses

200

OK

application/json

400

Bad Request

application/json

get

/{orgUid}/synthetics/v1/{uid}

HTTPcURLJavaScriptPython

GET /{orgUid}/synthetics/v1/{uid}?token=text HTTP/1.1
Host: apis.elven.works
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Synthetics

delete

Delete by uid

Path parameters

orgUidstringRequired

orgID (UUID)

uidstringRequired

uid

Query parameters

tokenstringRequired

Token authentication

Responses

200

OK

application/json

400

Bad Request

application/json

delete

/{orgUid}/synthetics/v1/{uid}

HTTPcURLJavaScriptPython

DELETE /{orgUid}/synthetics/v1/{uid}?token=text HTTP/1.1
Host: apis.elven.works
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Synthetics

get

Returns Synthetics by Env id

Path parameters

orgUidstringRequired

orgID (UUID)

Query parameters

environmentIdstringRequired

environmentId

tokenstringRequired

Token authentication

Responses

200

OK

application/json

400

Bad Request

application/json

get

/{orgUid}/synthetics/v1/environments

HTTPcURLJavaScriptPython

GET /{orgUid}/synthetics/v1/environments?environmentId=text&token=text HTTP/1.1
Host: apis.elven.works
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}