Rehive logo
Powered by Redocly

services

List services

SecurityapiAuth
Request
query Parameters
active
boolean
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

slug
string
type
string
type__in
Array of strings

Multiple values may be separated by commas.

Responses
200
get/3/admin/services/
Request samples 
rehive.admin.services.get()
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create service

SecurityapiAuth
Request
Request Body schema:
required
name
required
string <= 100 characters
description
string or null <= 255 characters
tags
Array of strings or null <= 10 items
url
required
string <= 250 characters
management_url
string or null <= 250 characters
Responses
201
post/3/admin/services/
Request samples
{
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "url": "string",
  • "management_url": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve service

SecurityapiAuth
Request
path Parameters
service_id
required
string^\d+$
Responses
200
get/3/admin/services/{service_id}/
Request samples 
rehive.admin.services.get(service_id)
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update service

SecurityapiAuth
Request
path Parameters
service_id
required
string^\d+$
Request Body schema:
required
name
string
description
string or null <= 255 characters
tags
Array of strings or null <= 10 items
url
string
management_url
string or null <= 250 characters
active
required
boolean
Responses
200
put/3/admin/services/{service_id}/
Request samples
{
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "url": "string",
  • "management_url": "string",
  • "active": true
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update service

SecurityapiAuth
Request
path Parameters
service_id
required
string^\d+$
Request Body schema:
name
string
description
string or null <= 255 characters
tags
Array of strings or null <= 10 items
url
string
management_url
string or null <= 250 characters
active
boolean
Responses
200
patch/3/admin/services/{service_id}/
Request samples
{
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "url": "string",
  • "management_url": "string",
  • "active": true
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete service

SecurityapiAuth
Request
path Parameters
service_id
required
string^\d+$
Responses
200
delete/3/admin/services/{service_id}/
Request samples 
rehive.admin.services.delete(service_id)
Response samples
application/json
{
  • "status": "sucess"
}

List service permissions

SecurityapiAuth
Request
path Parameters
service_id
required
string^\d+$
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/services/{service_id}/permissions/
Request samples 
rehive.admin.services.obj(service_id).permissions.get()
Response samples
application/json
{}

Create service permissions

SecurityapiAuth
Request
path Parameters
service_id
required
string^\d+$
Request Body schema:
required
required
Array of objects (CreatePermission)
Responses
201
post/3/admin/services/{service_id}/permissions/
Request samples
{
  • "permissions": [
    ]
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve service permission

SecurityapiAuth
Request
path Parameters
permission_id
required
string^\d+$
service_id
required
string^\d+$
Responses
200
get/3/admin/services/{service_id}/permissions/{permission_id}/
Request samples 
rehive.admin.services.obj(service_id).permissions.get(
  permission_id
)
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete service permission

SecurityapiAuth
Request
path Parameters
permission_id
required
string^\d+$
service_id
required
string^\d+$
Responses
200
delete/3/admin/services/{service_id}/permissions/{permission_id}/
Request samples 
rehive.admin.services.obj(service_id).permissions.delete(
  permission_id
)
Response samples
application/json
{
  • "status": "sucess"
}
➔ Next to subtypes