API Reference

Pause Database

post
https://{serverid}.nexusrun.com/databases/{databaseid}/pause

This API endpoint is designed to pause a running NexusRunDB database. Pausing the database will result in the failure of all API requests made to the database.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
  • Please note that only the Master access key or a token generated for the Master access key is allowed to access this endpoint.
Path Params
string
required

This is the unique database id you provided while creating database.

string
required

This is short name for the database location. This will be shown when new database is created at portal.

Headers
string

You need to pass either "Basic 'accesskey:accesssecret'" (base 64 encoded) or "Bearer {token}" authorization header.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 2 years ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json

Updated over 2 years ago