Skip to main content
POST
/
apiKey
/
v3
/
test-targets
/
{testTargetId}
/
environments
Create an environment
curl --request POST \
  --url https://app.octomind.dev/api/apiKey/v3/test-targets/{testTargetId}/environments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "discoveryUrl": "<string>",
  "testAccount": {
    "username": "<string>",
    "password": "<string>",
    "otpInitializerKey": "<string>"
  },
  "basicAuth": {
    "username": "<string>",
    "password": "<string>"
  },
  "privateLocationName": "<string>",
  "additionalHeaderFields": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "default",
  "testTargetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "DEFAULT",
  "updatedAt": "2023-11-07T05:31:56Z",
  "discoveryUrl": "<string>",
  "additionalHeaderFields": {},
  "testAccount": {
    "username": "<string>",
    "password": "<string>",
    "otpInitializerKey": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "basicAuth": {
    "username": "<string>",
    "password": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "privateLocation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "<string>",
    "type": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://octomind.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
testTargetId
string<uuid>
required

ID of the test target to which the environment belongs to

Body

application/json
​
name
string
​
discoveryUrl
string<url>
​
testAccount
object
​
basicAuth
object
​
privateLocationName
string

name of the private location

​
additionalHeaderFields
object

Response

environment created

​
id
string<uuid>
required
​
name
string
required
Example:

"default"

​
testTargetId
string<uuid>
required
​
type
enum<string>
required
Available options:
DEFAULT,
ADDITIONAL
Example:

"DEFAULT"

​
updatedAt
string<date-time>
​
discoveryUrl
string<url>
​
additionalHeaderFields
object
​
testAccount
object
​
basicAuth
object
​
privateLocation
object