Getting Started with the Static Proxy API

Overview

The QuarkIP Static Proxy API lets you retrieve your static proxy, look up transaction details, and renew nodes programmatically. All requests are sent over HTTPS and must include valid API credentials in the request headers.

The following endpoints are currently available:

Build the full request URL by combining the API domain provided by QuarkIP with the endpoint path:

https://{domain}/openapi/static/...

Replace {domain} with the API domain assigned to your account or integration environment.

Before you begin

Make sure you have the following information:

• Your QuarkIP API domain
• Your user-id
• Your access-key

You must include both credentials in the headers of every API request. Never expose your access-key in client-side code, screenshots, public webpages, or public source-code repositories.

Make your first request

The following request retrieves the first page of static proxy, with up to 20 records per page:

GET /openapi/static/node/list?page_no=1&page_limit=20 HTTP/1.1
Host: {domain}
client-id: {your-user-id}
access-key: {your-access-key}

Replace the placeholders with your actual API domain and credentials before sending the request.

A successful request returns 0 in the code field. The nodes are included in info.items:

{
  "code": 0,
  "msg": "Ok",
  "info": {
    "items": [],
    "item_total": 0,
    "page_no": 1,
    "page_limit": 20
  }
}

If no nodes match your request, items may be an empty array.

What to read next

• For details about request headers and response objects, see API Authentication and Response Formats.
• For a complete description of every node field, see List Static Proxy Nodes.
• If a request fails, see API Errors and Troubleshooting.