Platform Organization and Project API Reference

Manage your Pangea Organizations and Projects through the Console APIs

Base URL

api.console.<csp>.<region>.pangea.cloud

• OpenAPI Specification

post/v1beta/platform/org/get

cURL

Code Snippet Language

curl -sSLX POST 'https://api.console.aws.us.pangea.cloud/v1beta/platform/org/get' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

Get organization details

POST

https://api.console.aws.us.pangea.cloud/v1beta/platform/org/get

Retrieve details about the current organization.

required parameters

id

string

ID of the Pangea organization

​

ID of the Pangea organization

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

id

string

ID of the Pangea organization

ID of the Pangea organization

name

string

Human-readable name assigned to the organization. Not used as an identifier.

Human-readable name assigned to the organization. Not used as an identifier.

owner

string

ID of a Pangea user

ID of a Pangea user

owner_email

string

E-mail of the owner

E-mail of the owner

created_at

string (date-time)

Record creation timestamp in ISO 8601 format

Record creation timestamp in ISO 8601 format

updated_at

string (date-time)

Record update timestamp in ISO 8601 format

Record update timestamp in ISO 8601 format

csp

string

ID of the cloud service provider for the organization

ID of the cloud service provider for the organization

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1beta/platform/org/update

cURL

Code Snippet Language

curl -sSLX POST 'https://api.console.aws.us.pangea.cloud/v1beta/platform/org/update' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

Update organization

POST

https://api.console.aws.us.pangea.cloud/v1beta/platform/org/update

Update an organization

required parameters

id

string

ID of the Pangea organization

​

ID of the Pangea organization

name

string

Human-readable name assigned to the organization. Not used as an identifier.

name

name

Human-readable name assigned to the organization. Not used as an identifier.

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

id

string

ID of the Pangea organization

ID of the Pangea organization

name

string

Human-readable name assigned to the organization. Not used as an identifier.

Human-readable name assigned to the organization. Not used as an identifier.

owner

string

ID of a Pangea user

ID of a Pangea user

owner_email

string

E-mail of the owner

E-mail of the owner

created_at

string (date-time)

Record creation timestamp in ISO 8601 format

Record creation timestamp in ISO 8601 format

updated_at

string (date-time)

Record update timestamp in ISO 8601 format

Record update timestamp in ISO 8601 format

csp

string

ID of the cloud service provider for the organization

ID of the cloud service provider for the organization

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1beta/platform/project/get

cURL

Code Snippet Language

curl -sSLX POST 'https://api.console.aws.us.pangea.cloud/v1beta/platform/project/get' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

Get project

POST

https://api.console.aws.us.pangea.cloud/v1beta/platform/project/get

Retrieve a project

required parameters

id

string

ID of a Pangea project

​

ID of a Pangea project

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

id

string

ID of a Pangea project

ID of a Pangea project

name

string

Human-readable name assigned to the project. Project names are unique within an organization.

Human-readable name assigned to the project. Project names are unique within an organization.

org

string

ID of the Pangea organization

ID of the Pangea organization

created_at

string (date-time)

Record creation timestamp in ISO 8601 format

Record creation timestamp in ISO 8601 format

updated_at

string (date-time)

Record update timestamp in ISO 8601 format

Record update timestamp in ISO 8601 format

geo

string

High-level geographical area code for the project

High-level geographical area code for the project

region

string

Cloud region where the project is hosted

Cloud region where the project is hosted

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1beta/platform/project/list

cURL

Code Snippet Language

curl -sSLX POST 'https://api.console.aws.us.pangea.cloud/v1beta/platform/project/list' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

List organization projects

POST

https://api.console.aws.us.pangea.cloud/v1beta/platform/project/list

List organization projects

required parameters

org_id

string

ID of the Pangea organization

​

ID of the Pangea organization

optional parameters

filter

object

search

string

Comma-separated keywords to match against project ID, project name, or owner's email

search

search

Comma-separated keywords to match against project ID, project name, or owner's email

geo

string

High-level geographical area code for the project

geo

​

geo

High-level geographical area code for the project

region

string

Cloud region where the project is hosted

region

​

region

Cloud region where the project is hosted

offset

integer

Number of records to skip before starting to return results

offset

offset

Number of records to skip before starting to return results

limit

integer

Maximum number of records to return

limit

limit

Maximum number of records to return

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

results

array<object>

A list of projects

A list of projects

id

string

ID of a Pangea project

ID of a Pangea project

name

string

Human-readable name assigned to the project. Project names are unique within an organization.

Human-readable name assigned to the project. Project names are unique within an organization.

org

string

ID of the Pangea organization

ID of the Pangea organization

created_at

string (date-time)

Record creation timestamp in ISO 8601 format

Record creation timestamp in ISO 8601 format

updated_at

string (date-time)

Record update timestamp in ISO 8601 format

Record update timestamp in ISO 8601 format

geo

string

High-level geographical area code for the project

High-level geographical area code for the project

region

string

Cloud region where the project is hosted

Cloud region where the project is hosted

count

integer

Number of records returned

Number of records returned

offset

integer

Number of records skipped before starting to return results

Number of records skipped before starting to return results

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1beta/platform/project/create

cURL

Code Snippet Language

curl -sSLX POST 'https://api.console.aws.us.pangea.cloud/v1beta/platform/project/create' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

Create project

POST

https://api.console.aws.us.pangea.cloud/v1beta/platform/project/create

Create a project

required parameters

org_id

string

ID of the Pangea organization

​

ID of the Pangea organization

name

string

Human-readable name assigned to the project. Project names are unique within an organization.

name

name

Human-readable name assigned to the project. Project names are unique within an organization.

geo

string

High-level geographical area code for the project

geo

​

geo

High-level geographical area code for the project

region

string

Cloud region where the project is hosted

region

​

region

Cloud region where the project is hosted

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

id

string

ID of a Pangea project

ID of a Pangea project

name

string

Human-readable name assigned to the project. Project names are unique within an organization.

Human-readable name assigned to the project. Project names are unique within an organization.

org

string

ID of the Pangea organization

ID of the Pangea organization

created_at

string (date-time)

Record creation timestamp in ISO 8601 format

Record creation timestamp in ISO 8601 format

updated_at

string (date-time)

Record update timestamp in ISO 8601 format

Record update timestamp in ISO 8601 format

geo

string

High-level geographical area code for the project

High-level geographical area code for the project

region

string

Cloud region where the project is hosted

Cloud region where the project is hosted

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1beta/platform/project/update

cURL

Code Snippet Language

curl -sSLX POST 'https://api.console.aws.us.pangea.cloud/v1beta/platform/project/update' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

Update project

POST

https://api.console.aws.us.pangea.cloud/v1beta/platform/project/update

Update a project

required parameters

id

string

ID of a Pangea project

​

ID of a Pangea project

name

string

Human-readable name assigned to the project. Project names are unique within an organization.

name

name

Human-readable name assigned to the project. Project names are unique within an organization.

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

id

string

ID of a Pangea project

ID of a Pangea project

name

string

Human-readable name assigned to the project. Project names are unique within an organization.

Human-readable name assigned to the project. Project names are unique within an organization.

org

string

ID of the Pangea organization

ID of the Pangea organization

created_at

string (date-time)

Record creation timestamp in ISO 8601 format

Record creation timestamp in ISO 8601 format

updated_at

string (date-time)

Record update timestamp in ISO 8601 format

Record update timestamp in ISO 8601 format

geo

string

High-level geographical area code for the project

High-level geographical area code for the project

region

string

Cloud region where the project is hosted

Cloud region where the project is hosted

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

post/v1beta/platform/project/delete

cURL

Code Snippet Language

curl -sSLX POST 'https://api.console.aws.us.pangea.cloud/v1beta/platform/project/delete' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

Delete project

POST

https://api.console.aws.us.pangea.cloud/v1beta/platform/project/delete

Delete a project

required parameters

id

string

ID of a Pangea project

​

ID of a Pangea project

Response Fields

Response Schema

object

Pangea standard response schema

Pangea standard response schema

result

object

Empty object

Empty object

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Status Codes

Was this article helpful?

Contact us