Skip to content
OONI Docs

Create Oonirun Link

POST
/api/v2/oonirun/links

Create a new oonirun link or a new version for an existing one.

Request Body required

object
name
required
string
>= 2 characters <= 50 characters
short_description
required
string
>= 2 characters <= 200 characters
description
required
string
>= 2 characters
author
required
string
>= 2 characters <= 100 characters
nettests
required
Array<object>
object
test_name
string
"" >= 2 characters <= 100 characters
inputs
Array<string>
default:
options
object
backend_options
object
is_background_run_enabled_default
boolean
is_manual_run_enabled_default
boolean
name_intl
Any of:
object
key
additional properties
string
short_description_intl
Any of:
object
key
additional properties
string
description_intl
Any of:
object
key
additional properties
string
icon
Any of:
string
color
Any of:
string
/^#(?:[0-9a-fA-F]{6})$/
expiration_date

Future time after which the ooni run link will be considered expired and no longer editable or usable (defaults to 6 months from now)

string format: date-time

Responses

200

Successful Response

object
name
required
string
>= 2 characters <= 50 characters
short_description
required
string
>= 2 characters <= 200 characters
description
required
string
>= 2 characters
author
required
string
>= 2 characters <= 100 characters
nettests
required
Array<object>
object
test_name
string
"" >= 2 characters <= 100 characters
inputs
Array<string>
default:
options
object
backend_options
object
is_background_run_enabled_default
boolean
is_manual_run_enabled_default
boolean
name_intl
Any of:
object
key
additional properties
string
short_description_intl
Any of:
object
key
additional properties
string
description_intl
Any of:
object
key
additional properties
string
icon
Any of:
string
color
Any of:
string
/^#(?:[0-9a-fA-F]{6})$/
expiration_date

Future time after which the ooni run link will be considered expired and no longer editable or usable (defaults to 6 months from now)

string format: date-time
oonirun_link_id
required
string
date_created
required

Time when the ooni run link was created

string format: date-time
date_updated
required

Time when the ooni run nettest was last updated

string format: date-time
revision
required

Incremental number indicating the revision number of the ooni run link (the first revision is 1)

string
is_mine
Any of:
boolean
is_expired
required

Flag indicating if the ooni run link is expired (see the expiration_date field for more information)

boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string