Traceable · Example Payload

Traceable Download Api Spec Example

API DiscoveryAPI ProtectionAPI SecurityAPI TestingObservabilitySecurityThreat Detection

Traceable Download Api Spec Example is an example object payload from Traceable, with 2 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

requestresponse

Example Payload

Raw ↑ 
{
  "request": {
    "method": "GET",
    "url": "https://api.traceable.ai/rest/download?format=openapi-yaml&service=user-service&environment=production",
    "headers": {
      "Authorization": "Bearer {{TRACEABLE_API_TOKEN}}",
      "Accept": "application/x-yaml"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/x-yaml",
      "Content-Disposition": "attachment; filename=\"user-service-openapi.yaml\""
    },
    "body": "openapi: 3.0.3\ninfo:\n  title: User Service API\n  description: Discovered API specification for user-service generated by Traceable\n  version: 1.0.0\nservers:\n  - url: https://api.example.com\npaths:\n  /api/v1/users:\n    get:\n      operationId: getUsers\n      summary: Get Users\n      responses:\n        '200':\n          description: Successfully retrieved users\n  /api/v1/users/{id}:\n    get:\n      operationId: getUser\n      summary: Get User\n      parameters:\n        - name: id\n          in: path\n          required: true\n          schema:\n            type: string"
  }
}