OXdocs

OX web application

Get started using demo data

OX GraphQL API

Working with the OX API

Query reference

<aside> <img src="/icons/binoculars_purple.svg" alt="/icons/binoculars_purple.svg" width="40px" /> At a glance: Get started using the OX Security GraphQL API. Here, you’ll find everything you need to get ready to write and test queries.

</aside>

<aside> 💡 Tip: The information in this article applies both to organizations that have already connected their own repositories and to those using demo data. So even if you’re still using demo data, there’s no need to wait to give our API a try!

</aside>

About our API

The OX Security API is built using the GraphQL framework, created and open-sourced by Meta. GraphQL is especially useful for building visualizations and powers the OX application on the web.

GraphQL vs. REST

GraphQL clients

Endpoint

HTTP method

Authentication

HTTP headers

Example: Setting up GraphiQL to communicate with the OX API server

<aside> <img src="https://prod-files-secure.s3.us-west-2.amazonaws.com/9067557a-f182-48d7-a7aa-ab7215acdd95/82d1f7f1-c7c4-4408-b29b-2aae2e66a7ea/steps-icon.png" alt="https://prod-files-secure.s3.us-west-2.amazonaws.com/9067557a-f182-48d7-a7aa-ab7215acdd95/82d1f7f1-c7c4-4408-b29b-2aae2e66a7ea/steps-icon.png" width="40px" /> Next steps

Take a look at our Query reference to learn about the available API queries and get all the information you’ll need to start writing them.

</aside>

On this page

<aside> <img src="data:image/svg+xml,<svg stroke-width='2' id='Layer_1' data-name='Layer 1' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><defs><style>.cls-116lxtw0bhzr1joiyyzhs8v-1%7bfill:none%3bstroke:%236737FF%3bstroke-miterlimit:10%3b%3b%7d</style></defs><polyline class='cls-116lxtw0bhzr1joiyyzhs8v-1' points='18.29 16.52 22.5 17.73 22.5 4.36 15.82 2.46 8.18 4.36 1.5 2.46 1.5 15.82 8.18 17.73 11.62 16.87'/><line class='cls-116lxtw0bhzr1joiyyzhs8v-1' x1='8.18' y1='4.36' x2='8.18' y2='17.73'/><line class='cls-116lxtw0bhzr1joiyyzhs8v-1' x1='15.82' y1='11.17' x2='15.82' y2='2.45'/><circle class='cls-116lxtw0bhzr1joiyyzhs8v-1' cx='14.86' cy='14.86' r='3.82'/><line class='cls-116lxtw0bhzr1joiyyzhs8v-1' x1='17.73' y1='17.73' x2='21.55' y2='21.55'/></svg>" alt="data:image/svg+xml,<svg stroke-width='2' id='Layer_1' data-name='Layer 1' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><defs><style>.cls-116lxtw0bhzr1joiyyzhs8v-1%7bfill:none%3bstroke:%236737FF%3bstroke-miterlimit:10%3b%3b%7d</style></defs><polyline class='cls-116lxtw0bhzr1joiyyzhs8v-1' points='18.29 16.52 22.5 17.73 22.5 4.36 15.82 2.46 8.18 4.36 1.5 2.46 1.5 15.82 8.18 17.73 11.62 16.87'/><line class='cls-116lxtw0bhzr1joiyyzhs8v-1' x1='8.18' y1='4.36' x2='8.18' y2='17.73'/><line class='cls-116lxtw0bhzr1joiyyzhs8v-1' x1='15.82' y1='11.17' x2='15.82' y2='2.45'/><circle class='cls-116lxtw0bhzr1joiyyzhs8v-1' cx='14.86' cy='14.86' r='3.82'/><line class='cls-116lxtw0bhzr1joiyyzhs8v-1' x1='17.73' y1='17.73' x2='21.55' y2='21.55'/></svg>" width="40px" /> More to explore GraphQL's official documentation

</aside>