List Request Validations

GET /request-validations

Bearer auth

Retrieve Request Validations

Headers

x-integration-id string

Unique identifier of an integration

Minimum length is 24, maximum length is 24. Format should match the following pattern: IN[A-Za-z0-9_\-]+.

Responses

200 application/json

List Request Validations
Hide response attribute Show response attribute object
- route-validations array[object] Required
  
  List of route-specific Request Validations
  
  Not more than 1024 elements.
  
  Hide route-validations attributes Show route-validations attributes object
  
  routeKey string Required
  
  Minimum length is 13, maximum length is 13. Format should match the following pattern: RK[A-Za-z0-9_\-]+.
  
  route object Required
  
  Hide route attributes Show route attributes object
  
  method string
  
  HTTP method (GET, POST, PUT, DELETE, etc.)
  
  Values are GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, or PATCH.
  
  host string(uri)
  
  Host name
  
  Minimum length is 1, maximum length is 65535.
  
  port integer(int32)
  
  Minimum value is 1, maximum value is 65535.
  
  path string(uri)
  
  URL path pattern
  
  Minimum length is 1, maximum length is 8192.
  
  requestSchema object
  
  Hide requestSchema attributes Show requestSchema attributes object
  
  headerSchemaID string
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: SC[A-Za-z0-9_\-]+.
  
  querySchemaID string
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: SC[A-Za-z0-9_\-]+.
  
  bodySchemaID string
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: SC[A-Za-z0-9_\-]+.
  
  responseSchema object
  
  Hide responseSchema attributes Show responseSchema attributes object
  
  headerSchemaID string
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: SC[A-Za-z0-9_\-]+.
  
  bodySchemaID string
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: SC[A-Za-z0-9_\-]+.
400 application/json

Bad request
Hide response attributes Show response attributes object
- code string(string) Required
  
  Error code
  
  Minimum length is 1, maximum length is 64.
- message string(string) Required
  
  Human-readable error message
  
  Minimum length is 1, maximum length is 1024.
401 application/json

Unauthorized request
Hide response attributes Show response attributes object
- code string(string) Required
  
  Error code
  
  Minimum length is 1, maximum length is 64.
- message string(string) Required
  
  Human-readable error message
  
  Minimum length is 1, maximum length is 1024.
404 application/json

Resource not found
Hide response attributes Show response attributes object
- code string(string) Required
  
  Error code
  
  Minimum length is 1, maximum length is 64.
- message string(string) Required
  
  Human-readable error message
  
  Minimum length is 1, maximum length is 1024.
429 application/json

Too many requests
Hide response attributes Show response attributes object
- code string(string) Required
  
  Error code
  
  Minimum length is 1, maximum length is 64.
- message string(string) Required
  
  Human-readable error message
  
  Minimum length is 1, maximum length is 1024.
500 application/json

Internal server error
Hide response attributes Show response attributes object
- code string(string) Required
  
  Error code
  
  Minimum length is 1, maximum length is 64.
- message string(string) Required
  
  Human-readable error message
  
  Minimum length is 1, maximum length is 1024.

GET /request-validations

curl \
 --request GET '/api/v1/request-validations' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "x-integration-id: INx3zt0ygAcQGBAQEBAQEBAQ"

Response examples (200)

{
  "route-validations": [
    {
      "routeKey": "RKyx_d19M6zrA",
      "route": {
        "method": "GET",
        "host": "api.example.com",
        "port": 8080,
        "path": "/api/users/{id}"
      },
      "requestSchema": {
        "headerSchemaID": "SCx3zt0ygAcQGBAQEBAQEBAQ",
        "querySchemaID": "SCx3zt0ygAcQGBAQEBAQEBAQ",
        "bodySchemaID": "SCx3zt0ygAcQGBAQEBAQEBAQ"
      },
      "responseSchema": {
        "headerSchemaID": "SCx3zt0ygAcQGBAQEBAQEBAQ",
        "bodySchemaID": "SCx3zt0ygAcQGBAQEBAQEBAQ"
      }
    }
  ]
}

Response examples (400)

{
  "code": "string",
  "message": "string"
}

Response examples (401)

{
  "code": "string",
  "message": "string"
}

Response examples (404)

{
  "code": "string",
  "message": "string"
}

Response examples (429)

{
  "code": "string",
  "message": "string"
}

Response examples (500)

{
  "code": "string",
  "message": "string"
}