Rehive logo
Powered by Redocly

Platform Admin API (3 (3))

Download OpenAPI specification:Download

Rehive Support: support@rehive.com URL: https://rehive.com/support/ Terms of Service

The Platform Admin API is the core management component of the Rehive ecosystem. It provides adminsitrative access to platform resources.

User authentication (login) must still be performed via the Platform API because the Admin API only provides an interface for authenticating on behalf of users. The documentation for this can be found below:

For general usage, help, and recommendations please take a look at the platform docs.

Docs portal

access-control-rules

List access control rules

SecurityapiAuth
Request
query Parameters
action
string
group
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

type
string
user
string
Responses
200
get/3/admin/access-control-rules/
Request samples 
rehive.admin.access_control_rules.get()
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create access control rule

SecurityapiAuth
Request
Request Body schema:
required
action
required
string
  • allow - Allow
  • deny - Deny
Enum: "allow" "deny"
type
required
string
  • ip - Ip
Value: "ip"
value
required
string <= 100 characters
label
string or null <= 50 characters
user
string or null
group
string or null
Responses
201
post/3/admin/access-control-rules/
Request samples
{
  • "action": "allow",
  • "type": "ip",
  • "value": "string",
  • "label": "string",
  • "user": "string",
  • "group": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve access control rule

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
get/3/admin/access-control-rules/{id}/
Request samples 
rehive.admin.access_control_rules.get(
  access_control_rule_id
)
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Updated access control rule

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
required
action
required
string
  • allow - Allow
  • deny - Deny
Enum: "allow" "deny"
type
required
string
  • ip - Ip
Value: "ip"
value
required
string <= 100 characters
label
string or null <= 50 characters
user
string or null
group
string or null
Responses
200
put/3/admin/access-control-rules/{id}/
Request samples
{
  • "action": "allow",
  • "type": "ip",
  • "value": "string",
  • "label": "string",
  • "user": "string",
  • "group": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Prtially upadate access control rule

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
action
string
  • allow - Allow
  • deny - Deny
Enum: "allow" "deny"
type
string
  • ip - Ip
Value: "ip"
value
string <= 100 characters
label
string or null <= 50 characters
user
string or null
group
string or null
Responses
200
patch/3/admin/access-control-rules/{id}/
Request samples
{
  • "action": "allow",
  • "type": "ip",
  • "value": "string",
  • "label": "string",
  • "user": "string",
  • "group": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete access control rule

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
delete/3/admin/access-control-rules/{id}/
Request samples 
rehive.admin.access_control_rules.delete(
  access_control_rule_id
)
Response samples
application/json
{
  • "status": "sucess"
}
➔ Next to access-control-rules