Title: Get the Order ID of a VPS Block Storage Order Using the API  
PrimaryCategory: API  
Type: Procedural  
Tags: VPS, block storage, order ID, API, authentication, domain-name  
Source UI Terms: auth-userid, api-key, domain-name, HTTP Method  
Source Reference: Get the Order ID of a VPS Block Storage Order Using the API  

---

Prerequisites:  
- Have your API authentication credentials: auth-userid (Integer) and api-key (String).  
- Know the domain name associated with the VPS Block Storage order.

Steps:  
1) Construct an HTTP GET request to the API endpoint:  
   `https://test.httpapi.com/api/blockstorage/us/orderid.json`  
2) Include the following query parameters:  
   - `auth-userid` with your user ID (Integer)  
   - `api-key` with your API key (String)  
   - `domain-name` with the domain name for which you want to fetch the Order ID  
3) Send the GET request to retrieve the VPS Block Storage order ID associated with the domain name.

Example Request URL:  
```
https://test.httpapi.com/api/blockstorage/us/orderid.json?auth-userid=0&amp;api-key=key&amp;domain-name=vol-xxxxxx.in
```

Response:  
- The API returns the VPS Linux KVM Order ID associated with the specified domain name.

Warnings:  
- Ensure the authentication parameters are correct and valid to avoid access errors.  
- The domain name must be valid and linked to a VPS Block Storage order.

Summary:  
This procedure shows how to use the API with authentication and domain name parameters to retrieve the VPS Block Storage order ID.

Evaluation Pairs:  
Q1: What parameters are required to get the VPS Block Storage order ID using the API?  
A1: You need to provide `auth-userid` (Integer), `api-key` (String), and `domain-name` (String) as query parameters.  

Q2: What HTTP method is used to retrieve the VPS Block Storage order ID?  
A2: Use the GET HTTP method.  

Q3: What does the API response return when you query with the domain name?  
A3: It returns the VPS Linux KVM Order ID associated with that domain name.

<p>When you want to retrieve the associated VPS Block Storage order ID using the API. This article explains the required authentication parameters, domain name input, and order ID response information.</p>
<div class="region region-content">
<div class="hidden"> </div>
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Get Order ID</span></h1>
<div id="toc" style="display: block;">
<div id="toc_content"></div>
</div>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2>Description</h2>
<p>Gets the associated VPS Block Storage Order ID from the domain name.</p>
<h2><a name="heading_1"></a>Parameters</h2>
<table class="codetable"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">domain-name</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The domain name for which the Order ID is to be fetched</td></tr></tbody></table>
<h2>HTTP Method</h2>
<p>GET</p>
<h2>Example Test URL Request</h2>
<p><strong>US Server</strong> <code> https://test.httpapi.com/api/blockstorage/us/orderid.json?auth-userid=0&amp;api-key=key&amp;domain-name=vol-xxxxxx.in </code></p>
<h2>Response</h2>
<p>Returns the associated VPS Linux KVM Order ID of the domain name.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to retrieve the associated VPS Block Storage order ID using the API. This article explains the required authentication parameters, domain name input, and order ID response information.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
domain-name	String	Required	The domain name for which the Order ID is to be fetched