Terminal_services
This resource allows you to fetch Terminal Services.

Supported Formats

json

Errors

Code	Description
400	Bad Request.
404	Not found.
500	Internal Server Error.

Examples

# Get all available terminal services
curl 'https://app.octopi.co/api/v1/terminal_services' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

# Search services by name
curl 'https://app.octopi.co/api/v1/terminal_services?name=SERVICE_NAME' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

{
  "actions": {
    "index": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/terminal_services"
    },
    "next": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/terminal_services?page=2"
    },
    "previous": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/terminal_services?page=1"
    },
    "last": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/terminal_services?page=5"
    }
  },
  "terminal_services": [
    {
      "id": 1,
      "name": "Cleaning Service",
      "description": "Container cleaning service",
      "require_started_at": true,
      "require_ended_at": false,
      "accept_container_seals": false,
      "custom_value_type": {
        "id": 2,
        "name": "Count",
        "short_name": "cnt",
        "type_name": "number",
        "required": false
      }
    }
  ]
}

Params

Param name	Description
name optional	Search terminal services by name. Validations: Must be a String
page optional	Specify which page of results to fetch. This value defaults to 1. Validations: Must be a Integer
per optional	Number of terminal services to return per page. This value defaults to 10 and accepts a maximum of 100. Validations: Must be a Integer