Endpoints

Main blueprint

GET /

Return the application index

GET /status/(job_id)

Return the status of the job

Parameters
  • job_id (int) – The id of the job to pull

Return

json with the status of the job

User blueprint

POST /user/login

Login page

GET /user/login

Login page

GET /user/logout

Logout endpoint

POST /user/profile

User profile

GET /user/profile

User profile

POST /user/tokens/revoke

Endpoint to revoke a token

Inventory blueprint

GET /inventory/_retrieve_attributes/(kind)
GET /inventory/_retrieve_attributes_favorites
GET /inventory/_retrieve_free_stack_members/(host_id)

Return as json the free stack members numbers for the given host

If ics_id is passed in the query string, the member will be added to the list (if it exists)

Used to populate dynamically the stack_member field in the create and edit item forms

POST /inventory/_retrieve_items
POST /inventory/_update_favorites/(kind)

Update the current user favorite attributes

Add or remove the attribute from the favorites when the checkbox is checked/unchecked in the attributes table

POST /inventory/attributes/(kind)
GET /inventory/attributes/(kind)
GET /inventory/attributes/favorites
GET /inventory/items
GET /inventory/items/_generate_excel_file
POST /inventory/items/comment/(ics_id)
GET /inventory/items/comment/(ics_id)
POST /inventory/items/comment/delete
POST /inventory/items/comment/edit/(comment_id)
GET /inventory/items/comment/edit/(comment_id)
POST /inventory/items/create
GET /inventory/items/create
POST /inventory/items/edit/(ics_id)
GET /inventory/items/edit/(ics_id)
GET /inventory/items/view/(ics_id)
GET /inventory/scanner

Render the scanner setup codes

Network blueprint

GET /network/_generate_random_mac
GET /network/_retrieve_first_available_ip/(int: network_id)
POST /network/_retrieve_groups
POST /network/_retrieve_hosts
GET /network/_retrieve_ips/(subnet)/(int: prefix)
GET /network/_retrieve_scope_defaults/(int: scope_id)
GET /network/_retrieve_subnets/(int: scope_id)/(int: prefix)
GET /network/domains
POST /network/domains/create
GET /network/domains/create
GET /network/groups
POST /network/groups/create
GET /network/groups/create
POST /network/groups/delete
POST /network/groups/edit/(name)
GET /network/groups/edit/(name)
POST /network/groups/view/(name)
GET /network/groups/view/(name)
GET /network/hosts
POST /network/hosts/create
GET /network/hosts/create
POST /network/hosts/delete
POST /network/hosts/edit/(name)
GET /network/hosts/edit/(name)
POST /network/hosts/view/(name)
GET /network/hosts/view/(name)
POST /network/interfaces/create/(hostname)
GET /network/interfaces/create/(hostname)
POST /network/interfaces/delete
POST /network/interfaces/edit/(name)
GET /network/interfaces/edit/(name)
GET /network/networks
POST /network/networks/create
GET /network/networks/create
POST /network/networks/edit/(vlan_name)
GET /network/networks/edit/(vlan_name)
GET /network/networks/view/(vlan_name)
GET /network/scopes
POST /network/scopes/create
GET /network/scopes/create
POST /network/scopes/edit/(name)
GET /network/scopes/edit/(name)
GET /network/scopes/view/(name)