Tenant configurations

Manage Tenant Configurations

Retrieving configurations

get

Retrieves a list of configurations.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Query parameters
keysstringOptional
Responses
200

OK

application/json
get
/configuration/{tenant}/configurations
200

OK

Creating configurations

post

Creates new configurations.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Bodyall of[]
Responses
post
/configuration/{tenant}/configurations

Retrieving a configuration

get

Retrieves a specified configuration.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

propertyKeystringRequired

Desired configuration key.

Responses
200

OK

application/json
get
/configuration/{tenant}/configurations/{propertyKey}

Updating a configuration

put

Updates a specified configuration.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

propertyKeystringRequired

Desired configuration key.

Body
Responses
200

OK

application/json
put
/configuration/{tenant}/configurations/{propertyKey}

Deleting a configuration

delete

Deletes a specified configuration.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

propertyKeystringRequired

Desired configuration key.

Responses
delete
/configuration/{tenant}/configurations/{propertyKey}

No content

Last updated

Was this helpful?