api_keys

Forager public API (1.0.0)

Forager public API endpoints documentation

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://api-v2.forager.ai/

datastorage

Operations

organizations

Operations

persons

Operations

subscriptions

Operations

api_keys

Operations

List API keys

Request

API view for managing API keys.

curl -i -X GET \
  https://api-v2.forager.ai/api/api_keys/ \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
prefixstringread-onlyrequired
createdstring(date-time)read-onlyrequired
namestring<= 50 characters

A free-form name for the API key. Need not be unique. 50 characters max.

]
Response
application/json
[
  {
    "prefix": "string",
    "created": "2019-08-24T14:15:22Z",
    "name": "string"
  }
]

Create a new API key

Request

Handle creation of a new API key.

Body
namestring<= 50 characters

A free-form name for the API key. Need not be unique. 50 characters max.

curl -i -X POST \
  https://api-v2.forager.ai/api/api_keys/ \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string"
  }'

Responses

Bodyapplication/json
prefixstringread-onlyrequired
createdstring(date-time)read-onlyrequired
namestring<= 50 characters

A free-form name for the API key. Need not be unique. 50 characters max.

Response
application/json
{
  "prefix": "string",
  "created": "2019-08-24T14:15:22Z",
  "name": "string"
}

View API key details

Request

API view for managing API keys.

Path
prefixstringrequired
curl -i -X GET \
  'https://api-v2.forager.ai/api/api_keys/{prefix}/' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
prefixstringread-onlyrequired
createdstring(date-time)read-onlyrequired
namestring<= 50 characters

A free-form name for the API key. Need not be unique. 50 characters max.

Response
application/json
{
  "prefix": "string",
  "created": "2019-08-24T14:15:22Z",
  "name": "string"
}

Delete API key

Request

API view for managing API keys.

Path
prefixstringrequired
curl -i -X DELETE \
  'https://api-v2.forager.ai/api/api_keys/{prefix}/' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

No response body

users

Operations

objects-lookups

Operations