Create Sequence

POST 
/targets/:target_id/sequences/

Request

Path Parameters

target_id stringrequired

Identifier of the target.

Query Parameters

include string
Possible values: [target]
Extra fields to include in response:
• target - Add target to response under target key

application/json

Body

required

name stringnullablerequired

Possible values: <= 255 characters

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

custom_field_mappings

object[]

Array [

name stringrequired

value stringrequired

value_is_sensitive booleanrequired

]

content stringrequired

Contents of a sequence of browser navigation steps recorded by Snyk API and Web Sequence Recorder

application/x-www-form-urlencoded

Body

required

name stringnullablerequired

Possible values: <= 255 characters

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

custom_field_mappings

object[]

Array [

name stringrequired

value stringrequired

value_is_sensitive booleanrequired

]

content stringrequired

Contents of a sequence of browser navigation steps recorded by Snyk API and Web Sequence Recorder

multipart/form-data

Body

required

name stringnullablerequired

Possible values: <= 255 characters

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

custom_field_mappings

object[]

Array [

name stringrequired

value stringrequired

value_is_sensitive booleanrequired

]

content stringrequired

Contents of a sequence of browser navigation steps recorded by Snyk API and Web Sequence Recorder

Responses

201

application/json

Schema

Schema

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

custom_field_mappings

object[]

Array [

name stringrequired

value stringrequired

value_is_sensitive booleanrequired

]

content stringrequired

Contents of a sequence of browser navigation steps recorded by Snyk API and Web Sequence Recorder

Example (from schema)

{
  "id": "string",
  "name": "string",
  "requires_authentication": true,
  "type": "login",
  "enabled": true,
  "index": 0,
  "custom_field_mappings": [
    {
      "name": "string",
      "value": "string",
      "value_is_sensitive": true
    }
  ],
  "content": "string"
}

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...