Using the Public API

please note that the public api is not available in all hexiosec asm tiers if you would like access to the api, please contact us at support\@hexiosec com mailto\ support\@hexiosec com hexiosec asm provides a public http api, built using the openapi framework, that allows you to programmatically access and interact with your hexiosec asm data the following page details the steps to generate your personal api key and start using the api the main documentation page for the api can be found at https //asm hexiosec com/api/ui#overview https //asm hexiosec com/api/ui#overview the openapi specification for the api can be downloaded from https //asm hexiosec com/api/openapi yml https //asm hexiosec com/api/openapi yml you can also find out more about creating a scan using the api https //docs hexiosec com/asm/creating a scan using the api and paginating api requests https //docs hexiosec com/asm/paginating the api requests generate your api key from within the hexiosec asm app via the account icon, select 'account & preferences' give the api key a description and lifetime and then click 'create api key' from a browser where you are logged into hexiosec asm navigate to https //asm hexiosec com/api/ui#get /auth https //asm hexiosec com/api/ui#get /auth click 'try' from the 'response' copy the value for crsf navigate or scroll to https //asm hexiosec com/api/ui#post /users/api key https //asm hexiosec com/api/ui#post /users/api key in the example, update the 'description' and 'lifetime' as appropriate add the copied crsf to the request header x crsf token click 'try' you api key is the value under api key use your api key both examples below get the organisations for the logged in user in the browser navigate to https //asm hexiosec com/api/ui#auth https //asm hexiosec com/api/ui#auth add the api key to the value for the 'api key' navigate or scroll to https //asm hexiosec com/api/ui#get /v1/orgs https //asm hexiosec com/api/ui#get /v1/orgs click 'try' the result of the request can be seen in the 'response' tab in a terminal (via the steps above in a browser) do the steps above copy the value under the 'curl' tab paste the command and run it