Parameters

The Parameter API handles global parameters that either affects the current environment, or Bots individually. Bot parameters overrides environment parameters locally.

API SUBPATH: eva-parameter

Environment Parameters

Retrieves a list of parameters for an Environment. If the parameter field is supplied, you search filter the results by parameter name.

get

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

Query parameters

parameterstringoptional

It is the parameter's name to find

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/parameters'

200

400

401

403

404

409

422

500

200

{
  "data": [
    {
      "id": "text",
      "enabled": true,
      "description": "text",
      "key": "text",
      "value": "text"
    }
  ],
  "message": "text"
}

OK

Creates a new parameter/configuration within an Environment.

post

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

Body

keystringrequired

Parameter's key

valuestringrequired

Parameter's value

descriptionstringrequired

Parameter's description

enabledbooleanoptional

Flag that indicates if the parameter is enabled

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/parameters' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "text",
    "value": "text",
    "description": "text",
    "enabled": true
  }'

200

400

401

403

404

409

420

422

500

200

{
  "data": {
    "id": "text",
    "enabled": true,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

OK

Updates an existing parameter/configuration for a whole environment.

put

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

parameterIdstringrequired

Represents the id of environment

Body

keystringrequired

Parameter's key

valuestringrequired

Parameter's value

descriptionstringrequired

Parameter's description

enabledbooleanoptional

Flag that indicates if the parameter is enabled

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "text",
    "value": "text",
    "description": "text",
    "enabled": true
  }'

200

400

401

403

404

409

420

422

500

200

{
  "data": {
    "id": "text",
    "enabled": true,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

OK

Removes an existing parameter/configuration for a whole environment.

delete

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

parameterIdstringrequired

Represents the id of environment

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}'

200

400

401

403

404

409

422

500

200

No body

OK

Returns the current version for the cockpit server.

get

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/parameters/version'

200

400

401

403

404

409

422

500

200

{
  "data": {
    "value": "text"
  },
  "message": "text"
}

OK

Bot Parameters

Retrieves a list of parameters for a given bot. If the parameter field is supplied, you search filter the results by parameter name.

get

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

botUUIDstringrequired

Represents the id of bot

Query parameters

parameterstringoptional

It is the parameter's name to find

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters'

200

400

401

403

404

409

422

500

200

{
  "data": [
    {
      "id": "text",
      "enabled": true,
      "description": "text",
      "key": "text",
      "value": "text"
    }
  ],
  "message": "text"
}

OK

Creates a new parameter/configuration within a bot.

post

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

botUUIDstringrequired

Represents the id of bot

Body

keystringrequired

Parameter's key

valuestringrequired

Parameter's value

descriptionstringrequired

Parameter's description

enabledbooleanoptional

Flag that indicates if the parameter is enabled

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "text",
    "value": "text",
    "description": "text",
    "enabled": true
  }'

200

400

401

403

404

409

420

422

500

200

{
  "data": {
    "id": "text",
    "enabled": true,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

OK

Updates an existing parameter/configuration for a specific bot. Those take precedence over environment configurations.

put

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

botUUIDstringrequired

Represents the id of bot

parameterIdstringrequired

Represents the id of configuration

Body

keystringrequired

Parameter's key

valuestringrequired

Parameter's value

descriptionstringrequired

Parameter's description

enabledbooleanoptional

Flag that indicates if the parameter is enabled

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "text",
    "value": "text",
    "description": "text",
    "enabled": true
  }'

200

400

401

403

404

409

420

422

500

200

{
  "data": {
    "id": "text",
    "enabled": true,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

OK

Removes an existing parameter/configuration for a specific bot.

delete

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

botUUIDstringrequired

Represents the id of bot

parameterIdstringrequired

Represents the id of configuration

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId}'

200

400

401

403

404

409

422

500

200

No body

OK