---
title: "Settings - REST"
canonical: "https://docs.getxray.app/space/XRAY/301669159/Settings%20-%20REST"
format: markdown
---
# Settings

Some settings can be exported using the REST API.

This page provides a list of the available endpoints available for managing Xray related settings.


> Macro (toc)

## Test Statuses

To obtain a list of all Test (Run) Statuses, including the default ones, you just need to invoke the following endpoint.


> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> Returns a JSON object with all the Test (Run) Statuses.
> 
> ### ** **<span style="color: #003366">**Request**</span>
> 
> > ✅ **Example Request**
> > ✅ 
> > ✅ <span style="color: #000000">curl -H "Content-Type: application/json" -X GET -u admin:admin </span>[<span style="color: #000000">http://yourserver/rest/raven/1.0/api/settings/teststatuses</span>](http://yourserver/rest/raven/1.0/api/settings/teststatuses)
> 
> ### <span style="color: #003366">**Responses**</span>** **
> 
> 200 OK  :  **application/json**  : Successful. Returns a JSON with all the Test (Run) Statuses along with some information, including name, description, ranking and mapping to the requirement status.
> 
> ##### **Example Output**
> 
> ```
> [
>  {
>    "id": 1,
>    "rank": 1,
>    "name": "PASS",
>    "description": "The test run has passed",
>    "final": true,
>    "color":"#0a9600",
>    "requirementStatusName": "OK"
>  },
>  {
>    "id": 10,
>    "rank": 10,
>    "name": "BLOCKED",
>    "description": "The test run is blocked"
>    "final": false,
>    "color": "#000000",
>    "requirementStatusName": "NOTRUN"
>  }
>  ...
> ]
> ```
> 
> ### <span style="color: #003366">**Responses**</span>** **
> 
> 200 OK  :  **application/json**  : Successful. Returns a JSON with all the Test (Run) Statuses along with some information, including name, description, ranking and mapping to the requirement status.
> 
> 400 BAD_REQUEST : **text/plain** : Returns the error.
> 
> 401 UNAUTHORIZED : **text/plain** : The Xray license is not valid.
> 
> 500  INTERNAL SERVER ERROR  :  **text/plain**  : An internal error occurred getting the test statuses.

## Test Step Statuses

To obtain a list of all Tes Step Statuses, including the default ones, you just need to invoke the following endpoint.


> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> Returns a JSON object with all the Test Step Statuses.
> 
> ### ** **<span style="color: #003366">**Request**</span>
> 
> > ✅ **Example Request**
> > ✅ 
> > ✅ <span style="color: #000000">curl -H "Content-Type: application/json" -X GET -u admin:admin </span>[<span style="color: #000000">http://yourserver/rest/raven/1.0/api/settings/teststepstatuses</span>](http://yourserver/rest/raven/1.0/api/settings/teststepstatuses)
> 
> ### <span style="color: #003366">**Responses**</span>** **
> 
> 200 OK : **application/json** : Successful. Returns a JSON with all the Test Step Statuses along with some information, including name, description, ranking and mapping to the Test (Run) Status.
> 
> ##### **Example Output**
> 
> ```
> [
>  {
>    "id": 1,
>    "rank": 1,
>    "name": "PASS",
>    "description": "The test step has passed."
>    "testStatusId": 1 
>  },
>  {
>    "id": 10,
>    "rank": 10,
>    "name": "SKIP",
>    "description": "The test step has been skipped."
>    "testStatusId": 1 
>  }
>  ...
> ]
> 
> ```
> 
> 400 BAD_REQUEST : **text/plain** : Returns the error.
> 
> 401 UNAUTHORIZED : **text/plain** : The Xray license is not valid.
> 
> 500  INTERNAL SERVER ERROR : **text/plain** : An internal error occurred getting the test step statuses.