Roles / Orchestration Rules: Create

Description

Create a new Orchestration Rule associated to a Role.

HTTP Request

POST /api/v1beta0/user/envId/roles/roleId/orchestration-rules/

Parameters

Name Required Description Location
envId
integer
Yes

The ID of the Environment scoping this request.

path
roleId
integer
Yes

The ID of a Role object.

path

Request body

The JSON representation of a OrchestrationRule object.

The body must be a valid OrchestrationRule object. Example value:

{
  "action": {
    "actionType": "Action"
  }, 
  "blocking": true, 
  "enabled": true, 
  "order": 1, 
  "runAs": "string", 
  "target": {
    "targetType": "Target"
  }, 
  "timeout": 1, 
  "trigger": {
    "triggerType": "Trigger"
  }
}

Successful Response (Status 201)

The JSON representation of a OrchestrationRule object.

The API replies with a OrchestrationRuleDetailsResponse object. Example response body:

{
  "data": {
    "action": {
      "actionType": "Action"
    }, 
    "blocking": true, 
    "enabled": true, 
    "id": "string", 
    "order": 1, 
    "runAs": "string", 
    "scope": "scalr", 
    "target": {
      "targetType": "Target"
    }, 
    "timeout": 1, 
    "trigger": {
      "triggerType": "Trigger"
    }
  }, 
  "errors": [
    {
      "code": "string", 
      "message": "string"
    }
  ], 
  "meta": {
    "sample": "string"
  }, 
  "warnings": [
    {
      "code": "string", 
      "message": "string"
    }
  ]
}

Other Response Messages

HTTP Status Code Reason Response Model
400

A client-side error was made.

An ApiErrorResponse object
401

The request was not authenticated.

An ApiErrorResponse object
403

Insufficient permissions.

An ApiErrorResponse object
404

Resource not found.

An ApiErrorResponse object
409

Conflict with current state.

An ApiErrorResponse object
422

This request was well-formed but was rejected due to semantic errors.

An ApiErrorResponse object
500

A server-side error occurred.

An ApiErrorResponse object
501

This feature is not implemented in Scalr.

An ApiErrorResponse object
503

The service is currently unavailable.

An ApiErrorResponse object

Try it out!

Parameter Value Description
envId

The ID of the Environment scoping this request.

roleId

The ID of a Role object.

body

The JSON representation of a OrchestrationRule object.