Badrap App API (0.11.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

Installations

Installation management

List installations

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"removed": true
}
]

Get an installation by ID

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

ID of an installation

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"removed": true,
"state": { }
}

Update installation state and/or assets

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

ID of an installation

header Parameters

If-Match

required

string

Request Body schema: application/json

state	object
	Array of objects or objects or objects or objects

Responses

Request samples

Payload

Content type

application/json

{"state": { },
"assets": [{"type": "ip",
"value": "192.0.2.100",
"key": "AAAAAA==",
"props": {"title": "My example asset"
}
}
]
}

Delete an installation

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

ID of an installation

Responses

List installation owner's assets

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

ID of an installation

Responses

Response samples

200

Content type

application/json

[{"type": "ip",
"value": "192.0.2.100"
}
]

Send installation-scoped events to a feed

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> ID of an installation
name required	string (FeedName) [ 1 .. 32 ] characters ^[a-z0-9_-]{1,32}$ Name of a feed

Request Body schema: application/json

Array ()

One of

type required	string Value: "ip"
required	string or string an IPv4 or IPv6 address
key	string <byte> <= 64 characters
props	object

Responses

Request samples

Payload

Content type

application/json

[{"type": "ip",
"value": "192.0.2.100",
"key": "AAAAAA==",
"props": {"extra": "info"
}
}
]

Feeds

Feed management

List feeds

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

[{"name": "string"
}
]

Create a feed

Authorizations:

bearerAuth

Request Body schema: application/json

name required	string (FeedName) [ 1 .. 32 ] characters ^[a-z0-9_-]{1,32}$
title	string Nullable
summary_template	any (SummaryTemplate)
details_template	any (DetailsTemplate)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"title": "string",
"summary_template": null,
"details_template": null
}

Response samples

201

Content type

application/json

{"name": "string",
"title": "string",
"summary_template": null,
"details_template": null
}

Get a feed by name

Authorizations:

bearerAuth

path Parameters

name

required

string (FeedName) [ 1 .. 32 ] characters ^[a-z0-9_-]{1,32}$

Name of a feed

Responses

Response samples

200

Content type

application/json

{"name": "string",
"title": "string",
"summary_template": null,
"details_template": null
}

Modify a feed

Authorizations:

bearerAuth

path Parameters

name

required

string (FeedName) [ 1 .. 32 ] characters ^[a-z0-9_-]{1,32}$

Name of a feed

header Parameters

If-Match

required

string

Request Body schema: application/json

name	string (FeedName) [ 1 .. 32 ] characters ^[a-z0-9_-]{1,32}$
title	string Nullable
summary_template	any (SummaryTemplate)
details_template	any (DetailsTemplate)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"title": "string",
"summary_template": null,
"details_template": null
}

Response samples

200

Content type

application/json

{"name": "string",
"title": "string",
"summary_template": null,
"details_template": null
}

Delete a feed

Authorizations:

bearerAuth

path Parameters

name

required

string (FeedName) [ 1 .. 32 ] characters ^[a-z0-9_-]{1,32}$

Name of a feed

Responses

Send globally-scoped events to a feed

Authorizations:

bearerAuth

path Parameters

name

required

string (FeedName) [ 1 .. 32 ] characters ^[a-z0-9_-]{1,32}$

Name of a feed

Request Body schema: application/json

Array ()

One of

type required	string Value: "ip"
required	string or string an IPv4 or IPv6 address
key	string <byte> <= 64 characters
props	object

Responses

Request samples

Payload

Content type

application/json

[{"type": "ip",
"value": "192.0.2.100",
"key": "AAAAAA==",
"props": {"extra": "info"
}
}
]

Send installation-scoped events to a feed

Authorizations:

bearerAuth

path Parameters

id required	string <uuid> ID of an installation
name required	string (FeedName) [ 1 .. 32 ] characters ^[a-z0-9_-]{1,32}$ Name of a feed

Request Body schema: application/json

Array ()

One of

type required	string Value: "ip"
required	string or string an IPv4 or IPv6 address
key	string <byte> <= 64 characters
props	object

Responses

Request samples

Payload

Content type

application/json

[{"type": "ip",
"value": "192.0.2.100",
"key": "AAAAAA==",
"props": {"extra": "info"
}
}
]

UI

Validate an incoming bearer token

Authorizations:

bearerAuth

Request Body schema: application/json

token

required

string

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

200

Content type

application/json

{"installation_id": "91166175-c6a9-4caf-88e9-3147ffc9c934",
"session_id": "string",
"expires_at": 1622496600.5
}