Create a BGP authentication profile
POSThttps://api.strata.paloaltonetworks.com/config/network/v1/bgp-auth-profiles
Create a new BGP authentication profile.
Request
- application/json
Body
Created
- oneOf
- folder
- snippet
- device
The folder in which the resource is defined
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
My Folder
The snippet in which the resource is defined
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
My Snippet
The device in which the resource is defined
Possible values: <= 64 characters
, Value must match regular expression ^[a-zA-Z\d-_\. ]+$
My Device
Responses
- 201
- 400
- 401
- 403
- 409
- default
Created
Bad Request
- application/json
- Schema
- Example (auto)
- input_format_mismatch
- output_format_mismatch
- missing_query_parameter
- invalid_query_parameter
- missing_body
- invalid_object
Schema
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
Input Format Mismatch
{
"_errors": [
{
"code": "E003",
"message": "Input Format Mismatch: input-format=json",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Output Format Mismatch
{
"_errors": [
{
"code": "E003",
"message": "Output Format Mismatch: output-format=json Accept=xml",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Missing Query Parameter
{
"_errors": [
{
"code": "E003",
"message": "Missing Query Parameter: name",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Invalid Query Parameter
{
"_errors": [
{
"code": "E003",
"message": "Invalid Query Parameter: location=invalid",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Missing Body
{
"_errors": [
{
"code": "E003",
"message": "Missing Body",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Invalid Object
{
"_errors": [
{
"code": "E003",
"message": "Invalid Object",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Unauthorized
- application/json
- Schema
- Example (auto)
- auth_not_authenticated
- invalid_credential
- key_too_long
- key_expired
- need_password_change
Schema
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
Not Authenticated
{
"_errors": [
{
"code": "E016",
"message": "Not Authenticated",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Invalid Credential
{
"_errors": [
{
"code": "E016",
"message": "Invalid Credential",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Key Too Long
{
"_errors": [
{
"code": "E016",
"message": "Key Too Long",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Key Expired
{
"_errors": [
{
"code": "E016",
"message": "Key Expired",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Need Password Change
{
"_errors": [
{
"code": "E016",
"message": "The password needs to be changed.",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Forbidden
- application/json
- Schema
- Example (auto)
- auth_unauthorized
Schema
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
Unauthorized
{
"_errors": [
{
"code": "E007",
"message": "Unauthorized",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Conflict
- application/json
- Schema
- Example (auto)
- object_not_unique
- name_not_unique
- reference_not_zero
Schema
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
Object Not Unique
{
"_errors": [
{
"code": "E016",
"message": "Object Not Unique",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Name Not Unique
{
"_errors": [
{
"code": "E006",
"message": "Name Not Unique",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Reference Not Zero
{
"_errors": [
{
"code": "E009",
"message": "Reference Not Zero",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
General Errors
- application/json
- Schema
- Example (auto)
- version_not_supported
- method_not_allowed
- action_not_supported
- bad_xpath
- invalid_command
- malformed_command
- session_timeout
Schema
_errors object[]
{
"_errors": [
{
"code": "string",
"message": "string",
"details": {},
"help": "string"
}
],
"_request_id": "string"
}
Version Not Supported
{
"_errors": [
{
"code": "E012",
"message": "Version Not Supported",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Method Not Supported
{
"_errors": [
{
"code": "E012",
"message": "Method Not Supported",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Action Not Supported
{
"_errors": [
{
"code": "E012",
"message": "Action Not Supported: move",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Bad XPath
{
"_errors": [
{
"code": "E013",
"message": "Bad XPath",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Invalid Command
{
"_errors": [
{
"code": "E003",
"message": "Invalid Command",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Malformed Command
{
"_errors": [
{
"code": "E003",
"message": "Malformed Command",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Session Timeout
{
"_errors": [
{
"code": "4",
"message": "Session Timeout",
"details": {}
}
],
"_request_id": "123e4567-e89b-12d3-a456-426655440000"
}
Authorization: http
name: scmTokentype: httpdescription: Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the `client_id`, `client_secret` values associated with an IAM service account along with a scope value of `tsg_id:XXXXXXXXXX`, where `XXXXXXXXXX` is the Tenant Service Group (TSG) ID. The resulting JWT access token should be attached to all API calls as a `Bearer` token in the `Authorization` header (ex. `Authorization: Bearer tokenstring`). scheme: bearerbearerFormat: JWT
- curl
- python
- go
- nodejs
- csharp
- php
- CURL
curl -L 'https://api.strata.paloaltonetworks.com/config/network/v1/bgp-auth-profiles' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
"name": "string",
"secret": "string",
"folder": "My Folder"
}'