API docs by Redocly

OX Abuse Shield Report API (1.0.0)

Download OpenAPI specification:Download

License: GPL3

An API to retrieve and modify report information

getDevices

Retrieve information about devices matching the supplied criteria

Request Body schema: application/json

Query Parameters for retrieval commands

object (DeviceObject)
ip
string

Return information matching this IP address (v4 or v6). (ANDed with login and device if supplied)

login
string

Return information matching this login name (ANDed with IP and device if supplied)

max_age
string
Default: "1w"

Specify the maximum age of results to return (based on the login time). Using elasticsearch date math, e.g. 1d, 3M, or 12h. Defaults to 1w (one week)

max_num
integer
Default: 100

Specify the maximum number of results to return (defaults to 100)

Responses

Request samples

Content type
application/json
{
  • "ip": "243.22.12.98",
  • "login": "fred@foobar.com",
  • "max_age": "1w",
  • "max_num": 20
}

Response samples

Content type
application/json
{
  • "query": {
    },
  • "response": [
    ]
}

forgetDevice

Forget a particular device

Request Body schema: application/json

Forget Device Parameters

object (DeviceObject)
ip
string

Return information matching this IP address (v4 or v6). (ANDed with login and device if supplied)

login
string

Return information matching this login name (ANDed with IP and device if supplied)

max_age
string
Default: "1w"

Specify the maximum age of results to return (based on the login time). Using elasticsearch date math, e.g. 1d, 3M, or 12h. Defaults to 1w (one week)

max_num
integer
Default: 100

Specify the maximum number of results to return (defaults to 100)

Responses

Request samples

Content type
application/json
{
  • "ip": "243.22.12.98",
  • "login": "fred@foobar.com",
  • "max_age": "1w",
  • "max_num": 20
}

Response samples

Content type
application/json
{
  • "error_msg": "Could not parse max_age (-3dMwY)"
}

getLogins

Retrieve information about logins matching the supplied criteria

Request Body schema: application/json

Query Parameters for retrieval commands

object (DeviceObject)
ip
string

Return information matching this IP address (v4 or v6). (ANDed with login and device if supplied)

login
string

Return information matching this login name (ANDed with IP and device if supplied)

max_age
string
Default: "1w"

Specify the maximum age of results to return (based on the login time). Using elasticsearch date math, e.g. 1d, 3M, or 12h. Defaults to 1w (one week)

max_num
integer
Default: 100

Specify the maximum number of results to return (defaults to 100)

Responses

Request samples

Content type
application/json
{
  • "ip": "243.22.12.98",
  • "login": "fred@foobar.com",
  • "max_age": "1w",
  • "max_num": 20
}

Response samples

Content type
application/json
{
  • "query": {
    },
  • "response": [
    ]
}

confirmLogin

Confirm that a login is valid or invalid

Request Body schema: application/json

Confirm Login parameters

confirm
required
boolean

Boolean: true to confirm valid login, false to confirm invalid login

id
required
string

The ID of the login to confirm

Responses

Request samples

Content type
application/json
{
  • "confirm": true,
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error_msg": "Could not parse max_age (-3dMwY)"
}