docs.dev.asiga.com
Open in
urlscan Pro
18.238.4.127
Public Scan
Submitted URL: http://docs.dev.asiga.com/
Effective URL: https://docs.dev.asiga.com/
Submission: On March 21 via api from US — Scanned from US
Effective URL: https://docs.dev.asiga.com/
Submission: On March 21 via api from US — Scanned from US
Form analysis 0 forms found in the DOM
Text Content
* application
* optsCatch All
* devices
* getGet Devices
* postEnrol Device
* postEnrol Device
* getGet Devices With Status
* delRemove Device
* getGet Device
* getGet Device Status
* organisations
* getGet Organisations
* postCreate Organisation
* getGet Organisation
* putUpdate Organisation
* getGet Organisation Users
* news
* misc
* postOrgs
* getVersion
* users
* postCreate Users
* getGet Roles
* getSearch Users
* delDelete User
* getSearch User
* patchUpdate User
* getGet Block User
* putUpdate Block User
* delRemove Bfp User
* getGet Bfp User
* putReset User
* addresses
* postCreate Address
* delDelete Address
* getGet Address
* putUpdate Address
* enrol
* postEnrol Device
API docs by Redocly
ASIGA API (0.1.0)
Download OpenAPI specification:Download
Asiga: info@asiga.com URL: https://asiga.com/
The API for the Asiga Funnel
APPLICATION
API routes for application specific endpoints
CATCH ALL
PATH PARAMETERS
full_path
required
string (Full Path)
The full path being caught
RESPONSES
200
Successful Response
422
Validation Error
options/api/v1/{full_path}
Local Development Server
http://0.0.0.0:8080/api/v1/{full_path}
Production server
https://api.asiga.com/api/v1/{full_path}
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
null
DEVICES
API routes for device management endpoints
GET DEVICES
Get all devices.
AUTHORIZATIONS:
HTTPBearer
RESPONSES
200
Successful Response
get/api/v1/devices
Local Development Server
http://0.0.0.0:8080/api/v1/devices
Production server
https://api.asiga.com/api/v1/devices
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "name": "string",
* "attributes": {
* "organisation_id": 0,
* "active": true,
* "available_in_funnel": true
}
}
]
ENROL DEVICE
Enrol a device.
AUTHORIZATIONS:
HTTPBearer
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
serial_number
required
string (Serial Number)
RESPONSES
201
Successful Response
422
Validation Error
post/api/v1/devices/enrol
Local Development Server
http://0.0.0.0:8080/api/v1/devices/enrol
Production server
https://api.asiga.com/api/v1/devices/enrol
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "serial_number": "string"
}
RESPONSE SAMPLES
* 201
* 422
Content type
application/json
Copy
{
* "serial_number": "string",
* "certificate": "string",
* "broker_endpoint": "string",
* "private_key": "string",
* "organisation_name": "string"
}
ENROL DEVICE
Enrol a device.
AUTHORIZATIONS:
HTTPBearer
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
serial_number
required
string (Serial Number)
RESPONSES
201
Successful Response
422
Validation Error
post/api/v1/devices/enrol
Local Development Server
http://0.0.0.0:8080/api/v1/devices/enrol
Production server
https://api.asiga.com/api/v1/devices/enrol
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "serial_number": "string"
}
RESPONSE SAMPLES
* 201
* 422
Content type
application/json
Copy
{
* "serial_number": "string",
* "certificate": "string",
* "broker_endpoint": "string",
* "private_key": "string",
* "organisation_name": "string"
}
GET DEVICES WITH STATUS
Get all devices status.
AUTHORIZATIONS:
HTTPBearer
RESPONSES
200
Successful Response
get/api/v1/devices/status
Local Development Server
http://0.0.0.0:8080/api/v1/devices/status
Production server
https://api.asiga.com/api/v1/devices/status
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "name": "string",
* "attributes": {
* "organisation_id": 0,
* "active": true,
* "available_in_funnel": true
},
* "status": {
* "status": {
* "current_layer": 0,
* "current_layer_height": 0,
* "layer_count": 0
},
* "device_type": "string",
* "printer_technology": "string",
* "name": "string",
* "location": "string",
* "ip_address": "string",
* "model": "string",
* "serial_number": "string",
* "firmware_version": "string",
* "number_queued_jobs": 0,
* "number_notifications": 0,
* "progress": 0,
* "current_job_name": "string",
* "state": "string",
* "paused_by_user": true,
* "time_elapsed": 0,
* "time_remaining": 0,
* "queued_build_names": [
* "string"
]
}
}
]
REMOVE DEVICE
Remove a device.
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
serial_number
required
string (Serial Number)
The serial number of the device.
RESPONSES
204
Successful Response
422
Validation Error
delete/api/v1/devices/{serial_number}
Local Development Server
http://0.0.0.0:8080/api/v1/devices/{serial_number}
Production server
https://api.asiga.com/api/v1/devices/{serial_number}
RESPONSE SAMPLES
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "detail": [
* {
* "loc": [
* "string"
],
* "msg": "string",
* "type": "string"
}
]
}
GET DEVICE
Get a device.
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
serial_number
required
string (Serial Number)
The serial number of the device.
RESPONSES
200
Successful Response
422
Validation Error
get/api/v1/devices/{serial_number}
Local Development Server
http://0.0.0.0:8080/api/v1/devices/{serial_number}
Production server
https://api.asiga.com/api/v1/devices/{serial_number}
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "name": "string",
* "attributes": {
* "organisation_id": 0,
* "active": true,
* "available_in_funnel": true
}
}
GET DEVICE STATUS
Get a device status.
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
serial_number
required
string (Serial Number)
The serial number of the device.
RESPONSES
200
Successful Response
422
Validation Error
get/api/v1/devices/{serial_number}/status
Local Development Server
http://0.0.0.0:8080/api/v1/devices/{serial_number}/status
Production server
https://api.asiga.com/api/v1/devices/{serial_number}/status
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "name": "string",
* "attributes": {
* "organisation_id": 0,
* "active": true,
* "available_in_funnel": true
},
* "status": {
* "status": {
* "current_layer": 0,
* "current_layer_height": 0,
* "layer_count": 0
},
* "device_type": "string",
* "printer_technology": "string",
* "name": "string",
* "location": "string",
* "ip_address": "string",
* "model": "string",
* "serial_number": "string",
* "firmware_version": "string",
* "number_queued_jobs": 0,
* "number_notifications": 0,
* "progress": 0,
* "current_job_name": "string",
* "state": "string",
* "paused_by_user": true,
* "time_elapsed": 0,
* "time_remaining": 0,
* "queued_build_names": [
* "string"
]
}
}
ORGANISATIONS
API routes for organisations management endpoints
GET ORGANISATIONS
Get all organisations
AUTHORIZATIONS:
HTTPBearer
QUERY PARAMETERS
query
Query (string) or Query (null) (Query)
This parameter expects a Lucene query string for filtering results. For more
information on the syntax, please refer to the Lucene Query Parser
documentation. Note: fuzzy and proximity searches, boosting terms and field
grouping are not supported. Wildcard matches using * is supported.You can filter
by the following fields: name, addresses.country, id.
sorting
Sorting (string) or Sorting (null) (Sorting)
This parameter expects a sort query string for sorting results. This should be a
comma-separated list of {field_name}:{direction} pairs. The direction can be
either '-1' or '1' for descending and ascending respectively. For example,
'name:1,created_at:-1'. You can sort by the following fields: created_at, name,
id.
RESPONSES
200
Successful Response
422
Validation Error
get/api/v1/organisations
Local Development Server
http://0.0.0.0:8080/api/v1/organisations
Production server
https://api.asiga.com/api/v1/organisations
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": 1,
* "industry": "Other",
* "name": "Organisation 1"
}
]
CREATE ORGANISATION
Create a new organisation
AUTHORIZATIONS:
HTTPBearer
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
name
required
string (Name)
industry
required
string (OrganisationIndustry)
Enum: "Other" "Audiology" "Dental" "Jewelry" "Industrial" "Medical" "Creative"
"Microfluidics"
An enumeration of Organisation industries.
RESPONSES
201
Successful Response
422
Validation Error
post/api/v1/organisations
Local Development Server
http://0.0.0.0:8080/api/v1/organisations
Production server
https://api.asiga.com/api/v1/organisations
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "industry": "Other",
* "name": "New Organisation Name"
}
RESPONSE SAMPLES
* 201
* 422
Content type
application/json
Copy
{
* "id": 1,
* "industry": "Other",
* "name": "Organisation 1"
}
GET ORGANISATION
Get an organisation by ID
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
org_id
required
integer (Org Id)
The ID of the organisation to get
RESPONSES
200
Successful Response
422
Validation Error
get/api/v1/organisations/{org_id}
Local Development Server
http://0.0.0.0:8080/api/v1/organisations/{org_id}
Production server
https://api.asiga.com/api/v1/organisations/{org_id}
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
{
* "id": 1,
* "industry": "Other",
* "name": "Organisation 1"
}
UPDATE ORGANISATION
Update an organisation by ID
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
org_id
required
integer (Org Id)
The ID of the organisation to update
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
name
required
Name (string) or Name (null) (Name)
industry
required
OrganisationIndustry (string) or null
RESPONSES
200
Successful Response
422
Validation Error
put/api/v1/organisations/{org_id}
Local Development Server
http://0.0.0.0:8080/api/v1/organisations/{org_id}
Production server
https://api.asiga.com/api/v1/organisations/{org_id}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "industry": "Other",
* "name": "Updated organisation name"
}
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
{
* "id": 1,
* "industry": "Other",
* "name": "Organisation 1"
}
GET ORGANISATION USERS
Get users for an organisation with pagination.
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
org_id
required
integer (Org Id)
The ID of the organisation to get users for
QUERY PARAMETERS
page
Page (integer) or Page (null) (Page)
The page number.
per_page
Per Page (integer) or Per Page (null) (Per Page)
The number of items per page.
RESPONSES
200
Successful Response
422
Validation Error
get/api/v1/organisations/{org_id}/users
Local Development Server
http://0.0.0.0:8080/api/v1/organisations/{org_id}/users
Production server
https://api.asiga.com/api/v1/organisations/{org_id}/users
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "content": [
* {
* "app_metadata": {
* "organisation": 1
},
* "blocked": false,
* "created_at": "2021-01-01T00:00:00Z",
* "email": "user@example.com",
* "email_verified": true,
* "family_name": "Example",
* "given_name": "User",
* "identities": [
* {
* "provider": "auth0",
* "user_id": "usr_1234567890"
}
],
* "name": "User Example",
* "nickname": "UEx",
* "phone_number": "+11234567890",
* "phone_verified": true,
* "picture": "https://example.com/picture.jpg",
* "updated_at": "2021-01-02T00:00:00Z",
* "user_id": "usr_1234567890",
* "user_metadata": { },
* "username": "userexample"
}
],
* "description": "A paginated list of users.",
* "page": 0,
* "page_size": 10,
* "pages": 10,
* "total": 100
}
NEWS
API routes for news management endpoints
MISC
API routes for miscellaneous endpoints
ORGS
Asiga API orgs handler.
AUTHORIZATIONS:
HTTPBearer
RESPONSES
200
Successful Response
post/api/v1/orgs
Local Development Server
http://0.0.0.0:8080/api/v1/orgs
Production server
https://api.asiga.com/api/v1/orgs
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "payload": "Example Organisation"
}
VERSION
Asiga API version handler.
AUTHORIZATIONS:
HTTPBearer
RESPONSES
200
Successful Response
get/api/v1/version
Local Development Server
http://0.0.0.0:8080/api/v1/version
Production server
https://api.asiga.com/api/v1/version
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "version": "1.0.0"
}
USERS
API routes for user management endpoints
CREATE USERS
Create a new user
AUTHORIZATIONS:
HTTPBearer
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
email
required
string (Email)
roles
required
Array of strings (Roles)
name
Name (string) or Name (null) (Name)
RESPONSES
201
Successful Response
422
Validation Error
post/api/v1/users
Local Development Server
http://0.0.0.0:8080/api/v1/users
Production server
https://api.asiga.com/api/v1/users
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "email": "string",
* "roles": [
* "string"
],
* "name": "string"
}
RESPONSE SAMPLES
* 201
* 422
Content type
application/json
Copy
{
* "user_id": "string"
}
GET ROLES
Get available roles for users
AUTHORIZATIONS:
HTTPBearer
RESPONSES
200
Successful Response
get/api/v1/users/roles
Local Development Server
http://0.0.0.0:8080/api/v1/users/roles
Production server
https://api.asiga.com/api/v1/users/roles
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "roles": [
* {
* "id": "string",
* "name": "string"
}
]
}
SEARCH USERS
Search for users
AUTHORIZATIONS:
HTTPBearer
QUERY PARAMETERS
page
Page (string) or Page (null) (Page)
Pagination settings
sort
Sort (string) or Sort (null) (Sort)
Sort settings
fields
Fields (string) or Fields (null) (Fields)
A list of fields to return
query
Query (string) or Query (null) (Query)
Lucene query string
RESPONSES
200
Successful Response
422
Validation Error
get/api/v1/users/search
Local Development Server
http://0.0.0.0:8080/api/v1/users/search
Production server
https://api.asiga.com/api/v1/users/search
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "content": [
* {
* "app_metadata": {
* "organisation": 1
},
* "blocked": false,
* "created_at": "2021-01-01T00:00:00Z",
* "email": "user@example.com",
* "email_verified": true,
* "family_name": "Example",
* "given_name": "User",
* "identities": [
* {
* "provider": "auth0",
* "user_id": "usr_1234567890"
}
],
* "name": "User Example",
* "nickname": "UEx",
* "phone_number": "+11234567890",
* "phone_verified": true,
* "picture": "https://example.com/picture.jpg",
* "updated_at": "2021-01-02T00:00:00Z",
* "user_id": "usr_1234567890",
* "user_metadata": { },
* "username": "userexample"
}
],
* "description": "A paginated list of users.",
* "page": 0,
* "page_size": 10,
* "pages": 10,
* "total": 100
}
DELETE USER
Delete user
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
user_id
required
string (User Id)
The id of the user
RESPONSES
204
Successful Response
422
Validation Error
delete/api/v1/users/{user_id}
Local Development Server
http://0.0.0.0:8080/api/v1/users/{user_id}
Production server
https://api.asiga.com/api/v1/users/{user_id}
RESPONSE SAMPLES
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "detail": [
* {
* "loc": [
* "string"
],
* "msg": "string",
* "type": "string"
}
]
}
SEARCH USER
Get a users details
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
user_id
required
string (User Id)
The id of the user
RESPONSES
200
Successful Response
422
Validation Error
get/api/v1/users/{user_id}
Local Development Server
http://0.0.0.0:8080/api/v1/users/{user_id}
Production server
https://api.asiga.com/api/v1/users/{user_id}
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "app_metadata": {
* "organisation": 1
},
* "blocked": false,
* "created_at": "2021-01-01T00:00:00Z",
* "email": "user@example.com",
* "email_verified": true,
* "family_name": "Example",
* "given_name": "User",
* "identities": [
* {
* "provider": "auth0",
* "user_id": "usr_1234567890"
}
],
* "last_ip": "192.0.2.1",
* "last_login": "2021-01-02T12:00:00Z",
* "logins_count": 42,
* "multifactor": [
* "sms"
],
* "name": "User Example",
* "nickname": "UEx",
* "phone_number": "+11234567890",
* "phone_verified": true,
* "picture": "https://example.com/picture.jpg",
* "updated_at": "2021-01-02T00:00:00Z",
* "user_id": "usr_1234567890",
* "user_metadata": { },
* "username": "userexample"
}
UPDATE USER
Update a users details
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
user_id
required
string (User Id)
The id of the user
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
email
Email (string) or Email (null) (Email)
family_name
Family Name (string) or Family Name (null) (Family Name)
given_name
Given Name (string) or Given Name (null) (Given Name)
name
Name (string) or Name (null) (Name)
nickname
Nickname (string) or Nickname (null) (Nickname)
password
Password (string) or Password (null) (Password)
RESPONSES
200
Successful Response
422
Validation Error
patch/api/v1/users/{user_id}
Local Development Server
http://0.0.0.0:8080/api/v1/users/{user_id}
Production server
https://api.asiga.com/api/v1/users/{user_id}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "email": "string",
* "family_name": "string",
* "given_name": "string",
* "name": "string",
* "nickname": "string",
* "password": "string"
}
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "app_metadata": {
* "organisation": 1
},
* "blocked": false,
* "created_at": "2021-01-01T00:00:00Z",
* "email": "user@example.com",
* "email_verified": true,
* "family_name": "Example",
* "given_name": "User",
* "identities": [
* {
* "provider": "auth0",
* "user_id": "usr_1234567890"
}
],
* "last_ip": "192.0.2.1",
* "last_login": "2021-01-02T12:00:00Z",
* "logins_count": 42,
* "multifactor": [
* "sms"
],
* "name": "User Example",
* "nickname": "UEx",
* "phone_number": "+11234567890",
* "phone_verified": true,
* "picture": "https://example.com/picture.jpg",
* "updated_at": "2021-01-02T00:00:00Z",
* "user_id": "usr_1234567890",
* "user_metadata": { },
* "username": "userexample"
}
GET BLOCK USER
Get the block status of a user
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
user_id
required
string (User Id)
The id of the user
RESPONSES
200
Successful Response
422
Validation Error
get/api/v1/users/{user_id}/block
Local Development Server
http://0.0.0.0:8080/api/v1/users/{user_id}/block
Production server
https://api.asiga.com/api/v1/users/{user_id}/block
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
{
* "blocked": true
}
UPDATE BLOCK USER
Un/block a user
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
user_id
required
string (User Id)
The id of the user
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
blocked
boolean (Blocked)
Default: true
RESPONSES
204
Successful Response
422
Validation Error
put/api/v1/users/{user_id}/block
Local Development Server
http://0.0.0.0:8080/api/v1/users/{user_id}/block
Production server
https://api.asiga.com/api/v1/users/{user_id}/block
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "blocked": true
}
RESPONSE SAMPLES
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "detail": [
* {
* "loc": [
* "string"
],
* "msg": "string",
* "type": "string"
}
]
}
REMOVE BFP USER
Remove brute force protections blocks from a user
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
user_id
required
string (User Id)
The id of the user
RESPONSES
204
Successful Response
422
Validation Error
delete/api/v1/users/{user_id}/block/bfp
Local Development Server
http://0.0.0.0:8080/api/v1/users/{user_id}/block/bfp
Production server
https://api.asiga.com/api/v1/users/{user_id}/block/bfp
RESPONSE SAMPLES
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "detail": [
* {
* "loc": [
* "string"
],
* "msg": "string",
* "type": "string"
}
]
}
GET BFP USER
Get the brute force protections blocks of a user
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
user_id
required
string (User Id)
The id of the user
RESPONSES
200
Successful Response
422
Validation Error
get/api/v1/users/{user_id}/block/bfp
Local Development Server
http://0.0.0.0:8080/api/v1/users/{user_id}/block/bfp
Production server
https://api.asiga.com/api/v1/users/{user_id}/block/bfp
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "identifier": "string",
* "ip": "string",
* "connection": "string"
}
]
RESET USER
Send a reset password to a user
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
user_id
required
string (User Id)
The id of the user
RESPONSES
204
Successful Response
422
Validation Error
put/api/v1/users/{user_id}/reset
Local Development Server
http://0.0.0.0:8080/api/v1/users/{user_id}/reset
Production server
https://api.asiga.com/api/v1/users/{user_id}/reset
RESPONSE SAMPLES
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "detail": [
* {
* "loc": [
* "string"
],
* "msg": "string",
* "type": "string"
}
]
}
ADDRESSES
API routes for address management endpoints
CREATE ADDRESS
Create a new address.
AUTHORIZATIONS:
HTTPBearer
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
organisation_id
required
integer (Organisation Id)
street
required
string (Street)
city
required
string (City)
state
required
string (State)
country
required
string (Country)
postal_code
required
string (Postal Code)
RESPONSES
201
Successful Response
422
Validation Error
post/api/v1/addresses
Local Development Server
http://0.0.0.0:8080/api/v1/addresses
Production server
https://api.asiga.com/api/v1/addresses
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "city": "Springfield",
* "country": "AU",
* "organisation_id": 1,
* "postal_code": "1234",
* "state": "NSW",
* "street": "123 Fake St"
}
RESPONSE SAMPLES
* 201
* 422
Content type
application/json
Copy
{
* "city": "Springfield",
* "country": "AU",
* "id": 1,
* "organisation_id": 1,
* "postal_code": "1234",
* "state": "NSW",
* "street": "123 Fake St"
}
DELETE ADDRESS
Delete an address by ID.
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
address_id
required
integer (Address Id)
The ID of the address to get
RESPONSES
204
Successful Response
422
Validation Error
delete/api/v1/addresses/{address_id}
Local Development Server
http://0.0.0.0:8080/api/v1/addresses/{address_id}
Production server
https://api.asiga.com/api/v1/addresses/{address_id}
RESPONSE SAMPLES
* 422
Content type
application/json
Copy
Expand all Collapse all
{
* "detail": [
* {
* "loc": [
* "string"
],
* "msg": "string",
* "type": "string"
}
]
}
GET ADDRESS
Get an address by ID.
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
address_id
required
integer (Address Id)
The ID of the address to get
RESPONSES
200
Successful Response
422
Validation Error
get/api/v1/addresses/{address_id}
Local Development Server
http://0.0.0.0:8080/api/v1/addresses/{address_id}
Production server
https://api.asiga.com/api/v1/addresses/{address_id}
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
{
* "city": "Springfield",
* "country": "AU",
* "id": 1,
* "organisation_id": 1,
* "postal_code": "1234",
* "state": "NSW",
* "street": "123 Fake St"
}
UPDATE ADDRESS
Update an address by ID.
AUTHORIZATIONS:
HTTPBearer
PATH PARAMETERS
address_id
required
integer (Address Id)
The ID of the address to get
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
street
required
Street (string) or Street (null) (Street)
city
required
City (string) or City (null) (City)
state
required
State (string) or State (null) (State)
country
required
Country (string) or Country (null) (Country)
postal_code
required
Postal Code (string) or Postal Code (null) (Postal Code)
RESPONSES
200
Successful Response
422
Validation Error
put/api/v1/addresses/{address_id}
Local Development Server
http://0.0.0.0:8080/api/v1/addresses/{address_id}
Production server
https://api.asiga.com/api/v1/addresses/{address_id}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "city": "Springfield",
* "country": "AU",
* "postal_code": "1234",
* "state": "NSW",
* "street": "123 Fake St"
}
RESPONSE SAMPLES
* 200
* 422
Content type
application/json
Copy
{
* "city": "Springfield",
* "country": "AU",
* "id": 1,
* "organisation_id": 1,
* "postal_code": "1234",
* "state": "NSW",
* "street": "123 Fake St"
}
ENROL
API routes for device enrolment endpoints
ENROL DEVICE
Enrol a device.
AUTHORIZATIONS:
HTTPBearer
REQUEST BODY SCHEMA: APPLICATION/JSON
REQUIRED
serial_number
required
string (Serial Number)
RESPONSES
201
Successful Response
422
Validation Error
post/api/v1/devices/enrol
Local Development Server
http://0.0.0.0:8080/api/v1/devices/enrol
Production server
https://api.asiga.com/api/v1/devices/enrol
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "serial_number": "string"
}
RESPONSE SAMPLES
* 201
* 422
Content type
application/json
Copy
{
* "serial_number": "string",
* "certificate": "string",
* "broker_endpoint": "string",
* "private_key": "string",
* "organisation_name": "string"
}