Boomi Data Integration API Reference (1.0.0) - Variables

Toggle Pane

• Variables
  • getList Variables
  • putAdd Or Update Variables
  • delDelete Variable

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration

Variables

List Variables

Authorization scope: variables:list

List variables

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

Responses

Response Schema: application/json

variables required

object (Variables)

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/variables

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/variables

Response samples

• 200
• 422

Content type

application/json

{

• "variables": { }

}

Add Or Update Variables

Authorization scope: variables:edit

Add new variable or update existing one for environment

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

Request Body schema: application/json

required

variables required

object (Variables)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/variables

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/variables

Request samples

• Payload

Content type

application/json

{

• "variables": { }

}

Response samples

• 201
• 422

Content type

application/json

{

• "variables": { }

}

Delete Variable

Authorization scope: variables:edit

Delete existing variables by environment

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

query Parameters

variable_key required

string (Variable Key)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/variables

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/variables

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}