Link11 WAAP
v5
v5
  • Link11 WAAP Documentation
  • Release Notes
  • Known Issues
  • User Guide
    • Introduction to Link11 WAAP
  • How Link11 WAAP Works
    • Traffic Filtering Process
    • Traffic Reporting and Analytics
    • Policy Mapping and Traffic Routing
    • Tagging
    • UI Overview and Common Elements
  • Console UI Walkthrough
    • Analytics
      • Dashboard
      • Events Log
    • Security
      • Global Filters
      • Flow Control Policies
      • Security Policies
      • Rate Limit Rules
      • ACL Profiles
      • Actions
      • Dynamic Rules
      • Quarantined
      • Content Filter
        • Content Filter Profiles
        • Content Filter Rules
    • Sites
      • Server Groups
      • Proxy Templates
      • Mobile Application Groups
      • Backend Services
      • Edge Functions
      • DNS Records
      • SSL
        • Load Balancers
        • Certificates
    • System
      • Interactive Challenge
      • SSO Configuration
      • Purge CDN Cache
      • Users Management
      • Security Alerts
      • Log Exporters
      • Version Control
      • System DB
      • Publish Changes
    • Account
  • Using the product
    • Best Practices
      • Saving and Publishing Your Changes
      • Enabling Passive Challenges
      • Understanding and Diagnosing Traffic Issues
    • How Do I...
      • Authenticate mobile app users
      • Ban, unban, and allowlist traffic sources
      • Bypass Link11 WAAP for loadtesting or other purposes
      • Configure a new path/section of a site
      • Control caching behavior
      • Enable GraphQL traffic
      • Enable mTLS (mutual TLS)
      • Protect sensitive information in logs and analytics
      • Quickly block an attacker
      • Redirect or block HTTP traffic
      • Run custom code
      • Set rate limits and exemptions
      • Stream event data to a SIEM solution or other destination
    • The Link11 WAAP API
      • Overview
      • Internal data structures
      • Using Swagger UI
      • Using curl
  • Reference Information
    • Acronyms
    • API
      • API access to traffic data
      • Types of namespaces
      • Namespace reference
        • ACL Profiles
        • Actions
        • Backend Services
        • Certificates
        • Configs
        • Content Filter Profiles
        • Content Filter Rules
        • Data queries
        • Dynamic Rules
        • Edge Functions
        • Flow Control Policies
        • Global Filters
        • Load Balancers
        • Log Exporters
        • Mobile Application Groups
        • Planets
        • Proxy Templates
        • Rate Limit Rules
        • Security Alerts
        • Security Policies
        • Server Groups
        • Tags
        • Tools
        • Users
    • Hostile Bot Detection / LWCSI
      • Environmental detection and browser verification
      • Client authentication
      • Biometric behavioral verification
    • HTTP Response Codes
    • Log Exporter Output
    • Pattern Matching Syntax
    • Query Filter Syntax and Best Practices
  • Support
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Reference Information
  2. API
  3. Namespace reference

Tools

PreviousTagsNextUsers

Last updated 2 months ago

Was this helpful?

Get Planet DNS information

get

Get DNS zone ID and predefined records

Responses
200
Successfully retrieved DNS information
application/json
Responseany
400
Input Error
application/json
500
Internal Server Error
application/json
get
GET /api/v4.0/tools/dns-information HTTP/1.1
Host: 
Accept: */*

No content

  • POSTExtract Certificate from DER File
  • POSTExtract Certificate from PEM File
  • POSTExtract Certificate from PFX File
  • GETGet Planet DNS information
  • PUTPublish

Extract Certificate from DER File

post

When given a DER file, extracts and returns the certificate body

Body
fileNamestring · binaryRequired
passwordstringOptional

Required if the certificate is password-protected

Responses
200
Request was successful
application/json
Responseany
422
Validation Error
application/json
500
Internal Server Error
application/json
post
POST /api/v4.0/tools/certificates/extractder HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 39

{
  "fileName": "binary",
  "password": "text"
}

No content

Extract Certificate from PEM File

post

When given a PEM file, extracts and returns the certificate body

Body
fileNamestring · binaryRequired
passwordstringOptional

Required if the certificate is password-protected

Responses
200
Request was successful
application/json
Responseany
422
Validation Error
application/json
500
Internal Server Error
application/json
post
POST /api/v4.0/tools/certificates/extractpem HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 39

{
  "fileName": "binary",
  "password": "text"
}

No content

Extract Certificate from PFX File

post

When given a PFX file, extracts and returns the certificate body and private key

Body
fileNamestring · binaryRequired
passwordstringOptional

Required if the certificate is password-protected

Responses
200
Request was successful
application/json
Responseany
422
Validation Error
application/json
500
Internal Server Error
application/json
post
POST /api/v4.0/tools/certificates/extractpfx HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 39

{
  "fileName": "binary",
  "password": "text"
}

No content

Publish

put

Publish the current version of the specified configuration to the system storage bucket. By default, the name and url of the bucket are 'prod' and 'gs://rbz-$PLANETNAME-config/prod'. These values are also available in the console; navigate to System -> System DB -> select the system namespace -> publishinfo -> the buckets settings. Also, only one publish operation can occur at a time. If a 503 error is received, the previous operation has not yet finished, so the publish command should be resent until it is successful.

Path parameters
configstringRequired
Body
namestringOptional
urlstringOptional
Responses
200
Configuration published successfully
application/json
400
Publish Configuration Validation Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
503
Publish Already In Progress
application/json
put
PUT /api/v4.0/tools/publish/{config} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 30

[
  {
    "name": "text",
    "url": "text"
  }
]
{
  "message": "Successfully updated entry"
}