List Sequences

GET 
/targets/:target_id/sequences/

Request

Path Parameters

target_id stringrequired

Identifier of the target.

Query Parameters

enabled boolean
include string
Possible values: [content]
Extra fields to include in response:
• content - Add file contents to response under content key
length integer

Number of results to return per page.

name string
ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

search string

A search term.

type string
Possible values: [login, navigation]
• login - Login
• navigation - Navigation

Responses

200

application/json

Schema

Schema

count integer

Total number of results.

page_total integer

Total number of pages.

page integer

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

length integer

Number of results returned per page.

results

object[]

Array [

id stringrequired

A unique Base58 value identifying this object.

name stringnullablerequired

Possible values: <= 255 characters

requires_authentication boolean

type string

Possible values: [login, navigation]

• login - Login
• navigation - Navigation

enabled boolean

index integernullablerequired

]

Example (from schema)

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "string",
      "name": "string",
      "requires_authentication": true,
      "type": "login",
      "enabled": true,
      "index": 0
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

404

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...