Events / Actions: Fire

Description

It fires the Custom Event on the Server.

HTTP Request

POST /api/v1beta0/user/envId/events/eventId/actions/fire/

Parameters

Name Required Description Location
envId
integer		 Yes

The ID of the Environment scoping this request.

 path
eventId
string		 Yes

The ID of a Event object.

 path

Request body

Fire Event options.

Example value: 

{
  "server": {
    "id": "string"
  }
}

Fields description:

Name Required Description
server
ServerForeignKey		 Yes

Identifier of the Server.

Successful Response (Status 200)

The JSON representation of a EventLogEntry object.

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

{
  "data": {
    "event": {
      "id": "string"
    },
    "farm": {
      "id": 1
    },
    "farmRole": {
      "id": 1
    },
    "firedBy": "ui",
    "id": "string",
    "logEntries": [
      {
        "id": "string"
      }
    ],
    "server": {
      "id": "string"
    }
  },
  "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.
eventId

The ID of a Event object.
body

Fire Event options.