Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Priority Intelligence Requirements (PIR) API

The Priority Intelligence Requirements (PIR) API from APIs.io Engineering Platform — 4 operation(s) for priority intelligence requirements (pir).

This API exposes 6 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

6 operations 4 paths 18 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Priority Intelligence Requirements (PIR) API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Priority Intelligence Requirements (PIR) 6
POST
/accounts/{account_identifier}/cloudforce-one/requests/priority
APIs.io Engineering Platform List Priority Intelligence Requirements
cloudforce-one-priority-list 1 param body → 4XX200
DELETE
/accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}
APIs.io Engineering Platform Delete a Priority Intelligence Requirement
cloudforce-one-priority-delete 2 params → 4XX200
GET
/accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}
APIs.io Engineering Platform Get a Priority Intelligence Requirement
cloudforce-one-priority-get 2 params → 4XX200
PUT
/accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}
APIs.io Engineering Platform Update a Priority Intelligence Requirement
cloudforce-one-priority-update 2 params body → 4XX200
POST
/accounts/{account_identifier}/cloudforce-one/requests/priority/new
APIs.io Engineering Platform Create a New Priority Intelligence Requirement
cloudforce-one-priority-new 1 param body → 4XX200
GET
/accounts/{account_identifier}/cloudforce-one/requests/priority/quota
APIs.io Engineering Platform Get Priority Intelligence Requirement Quota
cloudforce-one-priority-quota 1 param → 4XX200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are cloudforce-one_request-item (13 properties), cloudforce-one_priority-item (7 properties), cloudforce-one_api-response-common-failure (4 properties), cloudforce-one_priority-edit (4 properties). Each schema is shown below with its type and property counts.

cloudforce-one_uuid
string
UUID
cloudforce-one_quota
object
4 properties
cloudforce-one_request-content
string
Request content
cloudforce-one_priority-edit
object
4 properties 4 required
cloudforce-one_request-type
string
Requested information from request
cloudforce-one_identifier
string
Identifier
cloudforce-one_tlp
string
The CISA defined Traffic Light Protocol (TLP)
cloudforce-one_time
string
cloudforce-one_request-status
string
Request Status
cloudforce-one_request-item
object
13 properties 8 required
cloudforce-one_api-response-common
object
3 properties 3 required
cloudforce-one_messages
array
cloudforce-one_request-summary
string
Brief description of the request
cloudforce-one_priority-list
object
2 properties 2 required
cloudforce-one_api-response-common-failure
object
4 properties 4 required
cloudforce-one_request-readable-id
string
Readable Request ID
cloudforce-one_priority-item
object
7 properties 7 required
cloudforce-one_labels
array
List of labels

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-priority-intelligence-requirements-pir-api-openapi.yml Raw ↑