User Guides

Using the Public API

4min

FractalScan Surface provides a public HTTP API, built using the OpenAPI framework, that allows you to programmatically access and interact with your FractalScan data. The following page details the steps to generate your personal API key and start using the API.
We will be adding a feature to allow you to manage your API keys within FractalScan Surface, lookout for updates regarding this and other new features.
The main documentation page for the API can be found at, https://app.fractalscan.com/api/ui#overview.
The OpenAPI specification for the API can be downloaded from, https://app.fractalscan.com/api/openapi.yml﻿
You can also find out more about creating a scan using the API and paginating API requests.
Please note that the public API is not available in all FractalScan Surface tiers. If you would like access to the API, please contact us at [email protected].
Generate your API key
From a browser where you are logged into FractalScan:
Navigate to: https://app.fractalscan.com/api/ui#get-/auth﻿
Click 'Try'
From the 'Response' copy the value for crsf
Navigate or scroll to: https://app.fractalscan.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://app.fractalscan.com/api/ui#auth﻿
Add the API key to the value for the 'API Key'
Navigate or scroll to: https://app.fractalscan.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
﻿

Updated 04 Apr 2024

Did this page help you?

Managing CDNs and Shared IPs

Creating a scan using the API

Docs powered by Archbee

TABLE OF CONTENTS

Generate your API key

Use your API key