AuthN Agreements API Reference

post/v2/agreements/create

curl -sSLX POST 'https://authn.aws.us.pangea.cloud/v2/agreements/create' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

Create an agreement

POST

https://authn.aws.us.pangea.cloud/v2/agreements/create

Create an agreement.

required parameters

type

string

An agreement type

type

name

string

A name to describe the agreement.

name

text

string

The body of the agreement.

text

optional parameters

active

boolean

A flag to that marks which of the agreements is currently active.

active

Response Fields

Response Schema

object

Pangea standard response schema

result

object

A EULA

type

string

An agreement type

id

string

An ID for an agreement

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

published_at

string (date-time)

A time in ISO-8601 format

name

string

text

string

active

boolean

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"

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"

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"

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"

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.

post/v2/agreements/delete

curl -sSLX POST 'https://authn.aws.us.pangea.cloud/v2/agreements/delete' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

Delete an agreement

POST

https://authn.aws.us.pangea.cloud/v2/agreements/delete

Delete an agreement.

required parameters

type

string

An agreement type

type

id

string

An ID for an agreement

Response Fields

Response Schema

object

Pangea standard response schema

result

object

An 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"

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"

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"

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"

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.

post/v2/agreements/list

curl -sSLX POST 'https://authn.aws.us.pangea.cloud/v2/agreements/list' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

List agreements

POST

https://authn.aws.us.pangea.cloud/v2/agreements/list

List agreements.

fields

filter

object

active

boolean

Only records where active equals this value.

active

created_at

string (date-time)

Only records where created_at equals this value.

created_at

created_at__gt

string (date-time)

Only records where created_at is greater than this value.

created_at__gt

created_at__gte

string (date-time)

Only records where created_at is greater than or equal to this value.

created_at__gte

created_at__lt

string (date-time)

Only records where created_at is less than this value.

created_at__lt

created_at__lte

string (date-time)

Only records where created_at is less than or equal to this value.

created_at__lte

id

string

Only records where id equals this value.

id

id__contains

array<string>

Only records where id includes each substring.

id__contains

id__in

array<string>

Only records where id equals one of the provided substrings.

id__in

name

string

Only records where name equals this value.

name

name__contains

array<string>

Only records where name includes each substring.

name__contains

name__in

array<string>

Only records where name equals one of the provided substrings.

name__in

published_at

string (date-time)

Only records where published_at equals this value.

published_at

published_at__gt

string (date-time)

Only records where published_at is greater than this value.

published_at__gt

published_at__gte

string (date-time)

Only records where published_at is greater than or equal to this value.

published_at__gte

published_at__lt

string (date-time)

Only records where published_at is less than this value.

published_at__lt

published_at__lte

string (date-time)

Only records where published_at is less than or equal to this value.

published_at__lte

text

string

Only records where text equals this value.

text

text__contains

array<string>

Only records where text includes each substring.

text__contains

text__in

array<string>

Only records where text equals one of the provided substrings.

text__in

type

string

Only records where type equals this value.

type

type__contains

array<string>

Only records where type includes each substring.

type__contains

type__in

array<string>

Only records where type equals one of the provided substrings.

type__in

updated_at

string (date-time)

Only records where updated_at equals this value.

updated_at

updated_at__gt

string (date-time)

Only records where updated_at is greater than this value.

updated_at__gt

updated_at__gte

string (date-time)

Only records where updated_at is greater than or equal to this value.

updated_at__gte

updated_at__lt

string (date-time)

Only records where updated_at is less than this value.

updated_at__lt

updated_at__lte

string (date-time)

Only records where updated_at is less than or equal to this value.

updated_at__lte

last

string

Reflected value from a previous response to obtain the next page of results.

last

order

string

Order results asc(ending) or desc(ending).

order

order_by

string

Which field to order results by.

order_by

size

integer

Maximum results to include in the response.

minimum: 1

size

Response Fields

Response Schema

object

Pangea standard response schema

result

object

agreements

array<object>

type

string

An agreement type

id

string

An ID for an agreement

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

published_at

string (date-time)

A time in ISO-8601 format

name

string

text

string

active

boolean

count

integer

last

string

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"

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"

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"

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"

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.

post/v2/agreements/update

curl -sSLX POST 'https://authn.aws.us.pangea.cloud/v2/agreements/update' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

Update agreement

POST

https://authn.aws.us.pangea.cloud/v2/agreements/update

Update an agreement.

required parameters

type

string

An agreement type

type

id

string

An ID for an agreement

optional parameters

name

string

The name of the agreement.

name

text

string

The body of the agreement.

text

active

boolean

A flag to that marks which of the agreements is currently active.

active

Response Fields

Response Schema

object

Pangea standard response schema

result

object

A EULA

type

string

An agreement type

id

string

An ID for an agreement

created_at

string (date-time)

A time in ISO-8601 format

updated_at

string (date-time)

A time in ISO-8601 format

published_at

string (date-time)

A time in ISO-8601 format

name

string

text

string

active

boolean

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"

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"

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"

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"

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.

Was this article helpful?

Contact us