View farms

>>>

GET /api/v1/view_farms
Display a list of all view farm render nodes attached to the application.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.
>>>

GET /api/v1/view_farms/:id
Display a view farm node.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the view farm node to be displayed.

Validations:

  • Must be a String
>>>

POST /api/v1/view_farms/:id/start
Start a view farm node.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the view farm node to be started.

Validations:

  • Must be a String
>>>

POST /api/v1/view_farms/:id/stop
Stop a view farm node.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the view farm node to be stopped.

Validations:

  • Must be a String
>>>

POST /api/v1/view_farms/:id/restart
Restart a view farm node.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the view farm node to be restarted.

Validations:

  • Must be a String
>>>

PUT /api/v1/view_farms/:id
Update the configuration of a view farm node.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the view farm node to be updated.

Validations:

  • Must be a String
config
required

New settings of a view farm node to be applied.

Validations:

  • Must be a Hash
>>>

POST /api/v1/view_farms/unpause_all
Unpauses all ViewFarms.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.
>>>

POST /api/v1/view_farms/pause_all
Pauses all ViewFarms.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.
>>>

DELETE /api/v1/view_farms/revoke
Detach a view farm node from the application.

Params

Param name Description
view_farm
optional , nil allowed

Validations:

  • Must be a Hash
view_farm[address]
optional

URL of the view farm node.

Validations:

  • Must be a String
view_farm[apikey]
optional

A view farm node identification string.

Validations:

  • Must be a String