Skip to main content

Seer Api (seer-api:v.0.3.9.3205149f)

Download OpenAPI specification:Download

Seer Api.

api

AppController_displayKeyUsage

Authorizations:
ApiKeyAuth

Responses

AppController_forwardRequestGet

Authorizations:
ApiKeyAuth

Responses

AppController_forwardRequestPost

Authorizations:
ApiKeyAuth

Responses

AppController_forwardRequestPut

Authorizations:
ApiKeyAuth

Responses

AppController_forwardRequestPatch

Authorizations:
ApiKeyAuth

Responses

AppController_forwardRequestDelete

Authorizations:
ApiKeyAuth

Responses

health

HealthController_check

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
status
string
object or null
object or null
object

Response samples

Content type
application/json
{
  • "status": "ok",
  • "info": {
    },
  • "error": { },
  • "details": {
    }
}

apikey

ApikeyController_getApikeyList

Authorizations:
ApiKeyAuth

Responses

Retrieve a single ApikeyEntity

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
fields
Array of strings

Selects resource fields. Docs

join
Array of strings

Adds relational resources. Docs

cache
integer [ 0 .. 1 ]

Reset cache (if was enabled). Docs

Responses

Response Schema: application/json
object (ApikeyEntity)

Response samples

Content type
application/json
{ }

Update a single ApikeyEntity

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
required
object (ApikeyEntity)

Responses

Response Schema: application/json
object (ApikeyEntity)

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Replace a single ApikeyEntity

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Request Body schema: application/json
required
object (ApikeyEntity)

Responses

Response Schema: application/json
object (ApikeyEntity)

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Delete a single ApikeyEntity

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Retrieve multiple ApikeyEntities

Authorizations:
ApiKeyAuth
query Parameters
fields
Array of strings

Selects resource fields. Docs

s
string

Adds search condition. Docs

filter
Array of strings

Adds filter condition. Docs

or
Array of strings

Adds OR condition. Docs

sort
Array of strings

Adds sort by field. Docs

join
Array of strings

Adds relational resources. Docs

limit
integer

Limit amount of resources. Docs

offset
integer

Offset amount of resources. Docs

page
integer

Page portion of resources. Docs

cache
integer [ 0 .. 1 ]

Reset cache (if was enabled). Docs

Responses

Response Schema: application/json
One of
data
required
Array of objects (ApikeyEntity)
count
required
number
total
required
number
page
required
number
pageCount
required
number

Response samples

Content type
application/json
Example
{
  • "data": [
    ],
  • "count": 0,
  • "total": 0,
  • "page": 0,
  • "pageCount": 0
}

Create a single ApikeyEntity

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
object (ApikeyEntity)

Responses

Response Schema: application/json
object (ApikeyEntity)

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Create multiple ApikeyEntities

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
bulk
required
Array of objects (ApikeyEntity)

Responses

Response Schema: application/json
Array
object (ApikeyEntity)

Request samples

Content type
application/json
{
  • "bulk": [
    ]
}

Response samples

Content type
application/json
[
  • { }
]