# API Structure

There are several different APIs, with some reserved for internal use only or specific user type use for security reasons. This information is clearly shown in the URL path, which also identifies the resource type and operation of the route in the structure below:

/{API Version}/{Usage Type}/{User Type}/{Resource Type}/{Operation}

/{API Version}/{Usage Type}/{User Type}/{Resource Type}/{Operation}/{Object ID}

**For example:**

<pre><code><strong>GET /1.0/private/user/invoice/search
</strong>DELETE /2.0/private/user/invoice/delete/inv_d2Ksn243901smZ
GET /2.0/private/user/proxy/retrieve/12992
PATCH /2.1/private/user/customer/edit
POST /2.1/private/user/customer/login
</code></pre>

**Resources**

The API provides a framework for programmatic operation on various Ping Proxies resources, allowing applications to interact with customer accounts, services and payment information. The API allows for operation on these resources:

```
Customer
Service
ServiceAdjustment
PaymentMethod
Notification
ApiKey
Authentication
Proxy
ProxyUser
Invoice
Transaction
BalanceTransaction
ApiRequest
Asn
City
Subdivision
Country
Continent
Log
LogSummary
ResidentialLedger
SubscriptionSchedule
```

**Standard Operations**

The API has various operations, some of which are resource specific, but many are standardized and consistent between resources. These are listed below with their method, though please note, not all operations are available for every resource for security reasons.

<table><thead><tr><th width="300">Operation</th><th>Method</th></tr></thead><tbody><tr><td>Search</td><td>GET</td></tr><tr><td>Retrieve</td><td>GET</td></tr><tr><td>Edit</td><td>PATCH</td></tr><tr><td>Delete</td><td>DELETE</td></tr><tr><td>Create</td><td>POST</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://internal.developer.documentation.private.user.pingproxies.com/basic-concepts/getting-started/api-structure.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.