Skip to content
Docs
Arcus
Popular questions
↑↓ to navigate↵ to selectesc to close
Book a demo

API call reference

This page lists the fields and options in the API call editor for REST API calls. To build and run a call, see API tests. For GraphQL calls, see GraphQL calls.

FieldWhat it does
MethodGET, POST, PUT, PATCH, DELETE, HEAD, or OPTIONS.
URLThe request URL. Can include variables, such as {env.base_url} or {user_id}.
VariablesLists every variable the request uses, where it’s used, and what it will be sent as. Give a value here to try the request with Send.
EnvironmentThe environment Send reads variables from: Project defaults (the project’s default variables) or one of the project’s environments.
SendSends the request from the editor without saving it.

The API call editor, with the request line, the request tabs, the Verify and Store tabs, and the response line outlined.

TabWhat it holds
ParametersQuery parameters, written into the URL after ?. Click + Param to add one.
BodyThe request body. See Body types.
HeadersRequest headers. Turn on Show auto headers to see the headers Arcus adds.
AuthorizationHow the request authenticates. See Authorization types.
SettingsRequest options. See Settings.
VerifyChecks on the response. See Verification types.
StoreValues to keep from the response. See Store sources.
Body typeUse it for
NoneRequests with no body.
form-dataMultipart form fields. A part can be a file from Uploads, sent as application/octet-stream.
x-www-form-urlencodedURL-encoded form fields.
RawA body you write in an editor, as JSON, XML, or Text.
BinaryOne file from Uploads, sent as the whole body.

The Body tab with the Body type list open: None, form-data, x-www-form-urlencoded, Raw, and Binary.

Secret fields are masked. To keep secrets out of the test, enter an environment reference, such as {env.api_token}.

The Authorization tab with the Type list open, from No Auth to NTLM Authentication.

TypeFields
No AuthNone.
Basic AuthUsername, Password.
Bearer TokenToken.
API KeyKey (the header or parameter name), Value, and Add Authorization data to: Request Headers or Query Parameters.
OAuth 2.0Grant Type, then the fields for it. See OAuth 2.0 grant types.
Digest AuthUsername, Password. Under Advanced: Algorithm (default MD5) and Quality of protection (default: as the server asks).
AWS SignatureAccess Key, Secret Key, AWS Region, Service Name, Session Token (optional), and Add signature to: Request Headers or Query Parameters.
Hawk AuthenticationHawk Auth ID, Hawk Auth Key, and Advanced options.
NTLM AuthenticationUsername, Password. Under Advanced: Domain and Workstation.
Grant typeFields
Client CredentialsAccess Token URL, Client ID, Client Secret, Scope, Client Authentication.
Password CredentialsAccess Token URL, Client ID, Client Secret, Username, Password, Scope.
Authorization CodeThe fields for the authorization code grant.
Authorization Code (PKCE)Auth URL, Access Token URL, Client ID, Client Secret (optional), Scope, Client Authentication, and Get New Token, available after you create the call.
TokenAccess Token, Refresh Token URL, Refresh Token.

Client Authentication sends the client credentials either as a Basic Auth header (the default) or in the body.

SettingDefault
Enable SSL certificate verificationOn
Automatically follow redirectsOff
Encode URL automatically: encodes the URL’s path, query parameters, and authentication fieldsOn
Cookie Management: keeps cookies from this request for later requests in the sessionOff
Follow original HTTP Method: keeps the method on a redirect instead of switching to GETOff
Remove referer header on redirectOff
Follow Authorization header: keeps the Authorization header on a redirectOff
Enable Advanced JSON Path Evaluation: runs currently ignore this settingOff
Request timeout, from 1 to 120 seconds30 seconds
Protocols disabled during handshakeNone
Cipher suite selectionDefault

The Settings tab, with the request options and their defaults.

Maximum number of redirects sets how many redirects a call follows when Automatically follow redirects is on.

SourceComparisons
StatusEquals, Not equals.
Response (JSON Path)Equals, Not equals, Contains, Does not contain, Starts with, Ends with, Matches regex, Is present, Is absent, Less than, Less than or equal, Greater than, Greater than or equal, Count equals, Count not equals, Count less than, Count less than or equal, Count greater than, Count greater than or equal, Is of type.
Headers, CookiesChecks on a response header or a cookie.
Response (Object)Compares the whole body with a value you write (Comparison Type: Raw) or with a JSON or XML file from Uploads (Comparison Type: Upload File). Verification Type: Strict, Strict Order, Lenient, Non Extensible, or Schema. See Compare the response with a file.

The Verify tab, with the verification sources, Add Verification, and a JSON path check outlined.

JSON paths start at $, the root of the body, for example $.name, $.data[0].id, or $.data with Count equals.

SourceStores
StatusThe status code.
HeadersA response header.
CookiesA response cookie.
Response (JSON Path)A body field, by JSON path.
ObjectsShown, but unavailable in this build.

The Store tab, with the store sources, Store Variable, and a stored value outlined.

Each stored value has a Variable Name, used in later calls as {variable_name}.

PartWhat it shows
Status lineThe status, such as 201 Created, the time, and the size.
Status, Headers, Response BodyThe status details, the response headers, and the body.
Body viewsOutline (a tree), JSON, HTML, XML, and Text.
Copy, Save, searchCopy the body, save it, or search its fields.
ExpandOpens the response in a larger view.

Was this page helpful?