{"info":{"title":"ApiTraffic API Documentation","version":"2.0.1"},"openapi":"3.0.0","servers":[{"url":"https://api.apitraffic.io/"}],"components":{"securitySchemes":{"client":{"type":"apiKey","name":"bearer","in":"header"}},"schemas":{"Verifies a token is valid.":{"type":"object","properties":{"accountSid":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"}},"required":["accountSid"]},"role":{"type":"string","description":"Role assigned to the API token","enum":["ingest","administrator","user"]},"Api Token":{"type":"object","properties":{"sid":{"type":"string","description":"The actual API token"},"accountSid":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"environmentSid":{"type":"string","description":"environmentSid","nullable":true,"pattern":"^[a-zA-Z0-9]{6}$"},"name":{"type":"string","description":"Name of the API token"},"role":{"$ref":"#/components/schemas/role"},"token":{"type":"string","description":"The API token"},"createdAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"updatedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"lastUsedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}}},"required":["sid","accountSid","environmentSid","name","role","createdAt","updatedAt"]},"API Token Collection":{"type":"array","items":{"$ref":"#/components/schemas/Api%20Token"}},"API Token Collection Response":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"Boolean value indicating if there are more records to paginate through."},"records":{"$ref":"#/components/schemas/API%20Token%20Collection"}},"required":["hasMore","records"]},"Exclusion":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the exclusion","pattern":"^xcl_[a-zA-Z0-9]{27}$"},"accountSid":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":{"type":"string","description":"A short description for the exclusion.","nullable":true},"criteria":{"type":"string","description":"The criteria that should be used to exclude requests."},"buckets":{"description":"An array of bucketSids that this exclusion should apply to.","anyOf":[{"$ref":"#/x-alt-definitions/buckets"},{"$ref":"#/x-alt-definitions/Model2"}]},"environments":{"description":"An array of environments to apply this to. This should be omitted to apply to all environments.","anyOf":[{"$ref":"#/x-alt-definitions/environments"},{"$ref":"#/x-alt-definitions/Model4"}]},"enabled":{"type":"boolean","description":"If the exclusion is currently enabled or not.","default":true},"createdAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"updatedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"deletedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}}},"required":["sid","accountSid","criteria","createdAt"]},"Exclusion Collection":{"type":"array","items":{"$ref":"#/components/schemas/Exclusion"}},"Exclusion Collection Response":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"Boolean value indicating if there are more records to paginate through."},"records":{"$ref":"#/components/schemas/Exclusion%20Collection"}},"required":["hasMore","records"]},"Bucket":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the bucket"},"accountSid":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"name":{"type":"string","description":"Name of the bucket"},"verifySslCerts":{"type":"boolean","description":"If SSL Certificates should be verified as valid and trusted."},"appIsConnected":{"type":"boolean","description":"If the bucket is connected to an application via the SDK."},"createdAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}}},"required":["sid","accountSid","name","verifySslCerts","appIsConnected","createdAt"]},"Bucket Collection":{"type":"array","items":{"$ref":"#/components/schemas/Bucket"}},"Bucket Collection Response":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"Boolean value indicating if there are more records to paginate through."},"records":{"$ref":"#/components/schemas/Bucket%20Collection"}},"required":["hasMore","records"]},"redactAt":{"type":"string","description":"Where the data should be redacted.","enum":["client","server"]},"level":{"type":"string","description":"The level of redaction that is applied to the data that is being redacted.","enum":["full","mask","partial"]},"applyTo":{"type":"string","description":"When using a custom type, where the pattern should apply. If key, the pattern will look for a JSON or XML key/property. If value, the pattern will look for any data in the payload that matches the pattern/regular and redact it.","enum":["key","value"],"nullable":true},"Redaction":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the redaction"},"accountSid":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":{"type":"string","description":"A short description for the redaction.","nullable":true},"buckets":{"description":"An array of bucketSids that this redaction should apply to.","anyOf":[{"$ref":"#/x-alt-definitions/buckets"},{"$ref":"#/x-alt-definitions/Model6"}]},"scopes":{"description":"The scopes for the redaction.","anyOf":[{"$ref":"#/x-alt-definitions/scopes"},{"$ref":"#/x-alt-definitions/Model8"}]},"pattern":{"type":"string","description":"The pattern that will be applied to find the data to redact.","nullable":true},"type":{"type":"string","description":"The type of redaction, this can be one of the predefined types or custom."},"redactAt":{"$ref":"#/components/schemas/redactAt"},"level":{"$ref":"#/components/schemas/level"},"applyTo":{"$ref":"#/components/schemas/applyTo"},"environments":{"description":"An array of environments to apply this to. This should be omitted to apply to all environments.","anyOf":[{"$ref":"#/x-alt-definitions/environments"},{"$ref":"#/x-alt-definitions/Model10"}]},"enabled":{"type":"boolean","description":"If the redaction is currently enabled or not.","default":true},"createdAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"updatedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"deletedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}}},"required":["sid","accountSid","pattern","type","redactAt","level","applyTo","enabled","createdAt"]},"Redaction Collection":{"type":"array","items":{"$ref":"#/components/schemas/Redaction"}},"Redaction Collection Response":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"Boolean value indicating if there are more records to paginate through."},"records":{"$ref":"#/components/schemas/Redaction%20Collection"}},"required":["hasMore","records"]},"bucketSids":{"type":"array","description":"Bucket sids this event applies to","items":{"type":"string"}},"environmentSids":{"type":"array","description":"Environment sids this event applies to","items":{"type":"string"}},"metadata":{"type":"object","description":"Freeform key/value metadata","nullable":true},"Event":{"type":"object","properties":{"sid":{"type":"string","description":"EventSid"},"accountSid":{"type":"string","description":"Sid of the account"},"bucketSids":{"$ref":"#/components/schemas/bucketSids"},"environmentSids":{"$ref":"#/components/schemas/environmentSids"},"type":{"type":"string","description":"Event type (e.g. deployment, incident, config_change)"},"name":{"type":"string","description":"Human-readable event name"},"description":{"type":"string","description":"Optional longer description","nullable":true},"source":{"type":"string","description":"Source of the event (e.g. github_actions, jenkins)","nullable":true},"metadata":{"$ref":"#/components/schemas/metadata"},"startedAt":{"type":"string","description":"When the event started","x-format":{"isoDate":true}},"endedAt":{"type":"string","description":"When the event ended (null for point-in-time events)","nullable":true,"x-format":{"isoDate":true}},"createdAt":{"type":"string","description":"When the record was created","x-format":{"isoDate":true}},"updatedAt":{"type":"string","description":"When the record was last updated","nullable":true,"x-format":{"isoDate":true}}},"required":["sid","accountSid","bucketSids","environmentSids","type","name","startedAt","createdAt"]},"Event Collection":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"Event Collection Response":{"type":"object","properties":{"hasMore":{"type":"boolean"},"records":{"$ref":"#/components/schemas/Event%20Collection"}},"required":["hasMore","records"]},"ThroughputPeriod":{"type":"object","description":"Metrics for requests in the 200 HTTP status code range.","properties":{"value":{"type":"number","description":"The actual metric value."},"maximum":{"type":"number","description":"This will only be returned when within the summary object."},"minimum":{"type":"number","description":"This will only be returned when within the summary object."},"median":{"type":"number","description":"This will only be returned when within the summary object."}},"required":["value"]},"Model1":{"type":"object","description":"Metrics for requests in the 300 HTTP status code range.","properties":{"value":{"type":"number","description":"The actual metric value."},"maximum":{"type":"number","description":"This will only be returned when within the summary object."},"minimum":{"type":"number","description":"This will only be returned when within the summary object."},"median":{"type":"number","description":"This will only be returned when within the summary object."}},"required":["value"]},"Model2":{"type":"object","description":"Metrics for requests in the 400 HTTP status code range.","properties":{"value":{"type":"number","description":"The actual metric value."},"maximum":{"type":"number","description":"This will only be returned when within the summary object."},"minimum":{"type":"number","description":"This will only be returned when within the summary object."},"median":{"type":"number","description":"This will only be returned when within the summary object."}},"required":["value"]},"ThroughputMetrics":{"type":"object","description":"The data structure that throuput data be reported back with.","properties":{"50":{"$ref":"#/components/schemas/ThroughputPeriod"},"95":{"$ref":"#/components/schemas/Model1"},"99":{"$ref":"#/components/schemas/Model2"}}},"ThroughputDetail":{"type":"object","properties":{"startTime":{"type":"string","description":"The start date/time for the period.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"The end date/time for the period.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"requests":{"type":"number","description":"Returning metric as requests per second (rps) or requests per minute (rpm)"},"maximum":{"type":"number","description":"Returning metric as requests per second (rps) or requests per minute (rpm)"},"minimum":{"type":"number","description":"Returning metric as requests per second (rps) or requests per minute (rpm)"},"average":{"type":"number","description":"Returning metric as requests per second (rps) or requests per minute (rpm)"},"percentiles":{"$ref":"#/components/schemas/ThroughputMetrics"}},"required":["startTime","endTime","requests","maximum","minimum","average"]},"periods":{"type":"array","items":{"$ref":"#/components/schemas/ThroughputDetail"}},"ResponseTimeResponse":{"type":"object","description":"The data structure that throuput data be reported back with.","properties":{"summary":{"$ref":"#/components/schemas/ThroughputDetail"},"periods":{"$ref":"#/components/schemas/periods"}},"required":["summary","periods"]},"units":{"type":"string","description":"The unit of the metric.","enum":["requests","milliseconds"]},"MetricDetail":{"type":"object","description":"Actual value for the metric at the given point in time.","properties":{"amount":{"type":"number","description":"The current value of the metric.","nullable":true},"units":{"$ref":"#/components/schemas/units"}},"required":["amount","units"]},"Model3":{"type":"string","description":"The unit of change.","enum":["percent","milliseconds"]},"MetricDetailChange":{"type":"object","description":"The amount of change in the value of the metric as compared to the previous period of time.","properties":{"amount":{"type":"number","description":"The amount of change for the same metric over the previous period.","nullable":true},"units":{"$ref":"#/components/schemas/Model3"}},"required":["amount","units"]},"requests":{"type":"object","description":"The request metrics for the given period.","properties":{"current":{"$ref":"#/components/schemas/MetricDetail"},"previous":{"$ref":"#/components/schemas/MetricDetail"},"change":{"$ref":"#/components/schemas/MetricDetailChange"}}},"responseTime":{"type":"object","description":"The response time metric for the given period.","properties":{"current":{"$ref":"#/components/schemas/MetricDetail"},"previous":{"$ref":"#/components/schemas/MetricDetail"},"change":{"$ref":"#/components/schemas/MetricDetailChange"}}},"errors":{"type":"object","description":"The error metric for the given period.","properties":{"current":{"$ref":"#/components/schemas/MetricDetail"},"previous":{"$ref":"#/components/schemas/MetricDetail"},"change":{"$ref":"#/components/schemas/MetricDetailChange"}}},"blocked":{"type":"object","description":"The requests blocked metric for the given period.","properties":{"current":{"$ref":"#/components/schemas/MetricDetail"},"previous":{"$ref":"#/components/schemas/MetricDetail"},"change":{"$ref":"#/components/schemas/MetricDetailChange"}}},"MetricsSummary":{"type":"object","description":"The data structure that each of the metrics will be reported back with.","properties":{"requests":{"$ref":"#/components/schemas/requests"},"responseTime":{"$ref":"#/components/schemas/responseTime"},"errors":{"$ref":"#/components/schemas/errors"},"blocked":{"$ref":"#/components/schemas/blocked"}},"required":["requests","responseTime","errors","blocked"]},"averageUnits":{"type":"string","description":"Returning metric as requests per second (rps) or requests per minute (rpm)","enum":["rps","rpm"]},"Model4":{"type":"object","description":"Metric for the total number of requests across all HTTP statuses.","properties":{"count":{"type":"number","description":"The request count."},"average":{"type":"number","description":"The average number of requests per unit."}},"required":["count","average"]},"Model5":{"type":"object","description":"Metrics for requests in the 200 HTTP status code range.","properties":{"count":{"type":"number","description":"The request count."},"average":{"type":"number","description":"The average number of requests per unit."}},"required":["count","average"]},"Model6":{"type":"object","description":"Metrics for requests in the 300 HTTP status code range.","properties":{"count":{"type":"number","description":"The request count."},"average":{"type":"number","description":"The average number of requests per unit."}},"required":["count","average"]},"Model7":{"type":"object","description":"Metrics for requests in the 400 HTTP status code range.","properties":{"count":{"type":"number","description":"The request count."},"average":{"type":"number","description":"The average number of requests per unit."}},"required":["count","average"]},"Model8":{"type":"object","description":"Metrics for requests in the 500 HTTP status code range.","properties":{"count":{"type":"number","description":"The request count."},"average":{"type":"number","description":"The average number of requests per unit."}},"required":["count","average"]},"Model9":{"type":"object","description":"The data structure that throuput data be reported back with.","properties":{"200":{"$ref":"#/components/schemas/Model5"},"300":{"$ref":"#/components/schemas/Model6"},"400":{"$ref":"#/components/schemas/Model7"},"500":{"$ref":"#/components/schemas/Model8"}}},"Model10":{"type":"object","properties":{"startTime":{"type":"string","description":"The start date/time for the period.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"The end date/time for the period.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"averageUnits":{"$ref":"#/components/schemas/averageUnits"},"total":{"$ref":"#/components/schemas/Model4"},"httpStatus":{"$ref":"#/components/schemas/Model9"}},"required":["startTime","endTime","averageUnits"]},"Model11":{"type":"object","properties":{"startTime":{"type":"string","description":"The start date/time for the period.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"The end date/time for the period.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"averageUnits":{"$ref":"#/components/schemas/averageUnits"},"total":{"$ref":"#/components/schemas/Model4"},"httpStatus":{"$ref":"#/components/schemas/Model9"}},"required":["startTime","endTime","averageUnits"]},"Model12":{"type":"array","items":{"$ref":"#/components/schemas/Model11"}},"ThroughputResponse":{"type":"object","description":"The data structure that throuput data be reported back with.","properties":{"summary":{"$ref":"#/components/schemas/Model10"},"periods":{"$ref":"#/components/schemas/Model12"}},"required":["summary","periods"]},"API token":{"type":"object","properties":{"sid":{"type":"string","description":"The actual API token"},"accountSid":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"environmentSid":{"type":"string","description":"environmentSid","nullable":true,"pattern":"^[a-zA-Z0-9]{6}$"},"name":{"type":"string","description":"Name of the API token"},"role":{"$ref":"#/components/schemas/role"},"token":{"type":"string","description":"The API token"},"createdAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"updatedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"lastUsedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}}},"required":["sid","accountSid","environmentSid","name","role","createdAt","updatedAt"]},"icon":{"type":"string","description":"The icon associated with the stream view.","enum":["search","star","alert","check","bolt","bookmark","flag","heart"]},"Stream View":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the stream view","pattern":"^sv_[a-zA-Z0-9]{27}$"},"bucketSid":{"type":"string","description":"Sid of the associated bucket"},"name":{"type":"string","description":"Name of the stream view"},"criteria":{"type":"string","description":"The search critiera for the view."},"icon":{"$ref":"#/components/schemas/icon"},"createdAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"updatedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"deletedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}}},"required":["sid","bucketSid","name","criteria","icon","createdAt"]},"Stream View Collection":{"type":"array","items":{"$ref":"#/components/schemas/Stream%20View"}},"Stream View Collection Response":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"Boolean value indicating if there are more records to paginate through."},"records":{"$ref":"#/components/schemas/Stream%20View%20Collection"}},"required":["hasMore","records"]},"direction":{"type":"string","description":"Denotes if the request was inbound to the API or an outbound reqeust the API sent.","enum":["in","out"]},"Request Firewall":{"type":"object","properties":{"blocked":{"type":"boolean","description":"Indicates if the request was blocked or not."}},"required":["blocked"]},"queryString":{"type":"object"},"Request":{"type":"object","properties":{"host":{"type":"string","description":"Host","nullable":true},"method":{"type":"string","description":"HTTP method","nullable":true},"path":{"type":"string","description":"Request path","nullable":true},"port":{"type":"number","description":"Request port","nullable":true},"url":{"type":"string","description":"The full url","nullable":true},"queryString":{"$ref":"#/components/schemas/queryString"},"headers":{"type":"object","required":["string"],"properties":{"string":{"anyOf":[{"type":"string"},{"type":"number"},{"$ref":"#/x-alt-definitions/string"},{"type":"boolean"}]}}},"body":{"type":"string"},"contentType":{"type":"string","description":"The content type of the request.","nullable":true},"size":{"type":"number","description":"The size of the request payload.","nullable":true}},"required":["host","method","path","url","headers","contentType","size"]},"Response":{"type":"object","nullable":true,"properties":{"statusCode":{"type":"number","description":"HTTP status code that was returned by the target server.","nullable":true},"headers":{"type":"object","nullable":true,"required":["string"],"properties":{"string":{"nullable":true,"anyOf":[{"type":"string"},{"type":"number"},{"$ref":"#/x-alt-definitions/string"},{"type":"boolean"}]}}},"size":{"type":"number","description":"The size of the response payload.","nullable":true},"body":{"type":"string"},"contentType":{"type":"string","description":"The content type of the response.","nullable":true}},"required":["headers","size","contentType"]},"Request Timing Phases":{"type":"object","properties":{"dns":{"type":"number","description":"Difference between lookup and socket times.","nullable":true},"tcp":{"type":"number","description":"Difference between connect and lookup times.","nullable":true},"tls":{"type":"number","description":"Difference between secureConnect and connect times.","nullable":true},"wait":{"type":"number","description":"Difference between socket and start times.","nullable":true},"total":{"type":"number","description":"(timings.end || timings.error || timings.abort) - timings.start","nullable":true},"request":{"type":"number","description":"timings.upload - (timings.secureConnect || timings.connect)","nullable":true},"download":{"type":"number","description":"Difference between end and response times.","nullable":true},"firstByte":{"type":"number","description":"Difference between response and upload times.","nullable":true}}},"Request Timings":{"type":"object","nullable":true,"properties":{"duration":{"type":"number","description":"The total duration of the request.","nullable":true},"start":{"type":"number","description":"Time when the request started.","nullable":true},"end":{"type":"number","description":"Time when the response fired end event.","nullable":true},"lookup":{"type":"number","description":"Time when the DNS lookup finished.","nullable":true},"socket":{"type":"number","description":"Time when a socket was assigned to the request.","nullable":true},"upload":{"type":"number","description":"Time when the request finished uploading.","nullable":true},"connect":{"type":"number","description":"Time when the socket successfully connected.","nullable":true},"response":{"type":"number","description":"Time when the request fired response event.","nullable":true},"secureConnect":{"type":"number","description":"Time when the socket securely connected.","nullable":true},"abort":{"type":"number","description":"Time when the request fired abort event.","nullable":true},"error":{"type":"number","description":"Time when the request fired error event.","nullable":true},"phases":{"$ref":"#/components/schemas/Request%20Timing%20Phases"}}},"Request Traces":{"type":"array","nullable":true,"items":{"type":"string"}},"Workflows that were executed as a result of this request.":{"type":"array","nullable":true,"items":{"type":"string"}},"Model13":{"type":"object","properties":{"sid":{"type":"string","description":"RequestSid","pattern":"^req_[a-zA-Z0-9]{27}$"},"bucketSid":{"type":"string","description":"Sid of the bucket"},"environmentSid":{"type":"string","description":"Sid of the environment","nullable":true,"pattern":"^[a-z0-9]{6}$"},"contextSid":{"type":"string","description":"Sid of the request context.","nullable":true},"direction":{"$ref":"#/components/schemas/direction"},"note":{"type":"string","description":"Any notes that were added to the request.","nullable":true},"createdAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"receivedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"firewall":{"$ref":"#/components/schemas/Request%20Firewall"},"request":{"$ref":"#/components/schemas/Request"},"response":{"$ref":"#/components/schemas/Response"},"timings":{"$ref":"#/components/schemas/Request%20Timings"},"traces":{"$ref":"#/components/schemas/Request%20Traces"},"workflowExecutions":{"$ref":"#/components/schemas/Workflows%20that%20were%20executed%20as%20a%20result%20of%20this%20request."},"tags":{"type":"object","nullable":true,"required":["string"],"properties":{"string":{"anyOf":[{"type":"string"},{"type":"number"},{"$ref":"#/x-alt-definitions/string"},{"type":"boolean"}]}}},"capture":{"type":"boolean"},"storage":{"type":"string"}},"required":["sid","bucketSid","direction","note","tags"]},"Request Collection":{"type":"array","items":{"$ref":"#/components/schemas/Model13"}},"Request Collection Response":{"type":"object","properties":{"hasMore":{"type":"boolean","description":"Boolean value indicating if there are more records to paginate through."},"from":{"type":"string","description":"If there are more records, this is the from that needs to be passed in to paginate.","nullable":true,"pattern":"^req_[a-zA-Z0-9]{27}$"},"properties":{"type":"string"},"records":{"$ref":"#/components/schemas/Request%20Collection"}},"required":["hasMore","from","records"]},"Model14":{"type":"array","description":"Array of bucket SIDs to scope to (empty = all buckets in environment)","items":{"type":"string"}},"Model15":{"type":"object","properties":{"name":{"type":"string","description":"Name of the MCP token"},"environmentSid":{"type":"string","description":"Environment SID to scope this token to"},"bucketSids":{"$ref":"#/components/schemas/Model14"}},"required":["name","environmentSid"]},"Redaction Payload":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the redaction is currently enabled or not.","default":true},"description":{"type":"string","description":"A short description for the redaction.","nullable":true},"pattern":{"type":"string","description":"The pattern that will be applied to find the data to redact.","nullable":true},"redactAt":{"$ref":"#/components/schemas/redactAt"},"type":{"type":"string","description":"The type of redaction, this can be one of the predefined types or custom."},"level":{"$ref":"#/components/schemas/level"},"applyTo":{"$ref":"#/components/schemas/applyTo"},"environments":{"description":"An array of environments to apply this to. This should be omitted to apply to all environments.","anyOf":[{"$ref":"#/x-alt-definitions/environments"},{"$ref":"#/x-alt-definitions/Model12"}]},"buckets":{"description":"An array of bucketSids that this redaction should apply to.","anyOf":[{"$ref":"#/x-alt-definitions/buckets"},{"$ref":"#/x-alt-definitions/Model14"}]},"scopes":{"description":"The scopes for the redaction.","anyOf":[{"$ref":"#/x-alt-definitions/Model15"},{"$ref":"#/x-alt-definitions/Model17"}]}},"required":["enabled","pattern","redactAt","type","level","applyTo"]},"Model16":{"type":"object","properties":{"name":{"type":"string","description":"The name of the bucket"}},"required":["name"]},"Exclusion Creation Payload":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the exclusion is currently enabled or not.","default":true},"description":{"type":"string","description":"A short description for the exclusion.","nullable":true},"criteria":{"type":"string","description":"The criteria that should be used to exclude requests."},"environments":{"description":"An array of environments to apply this to. This should be omitted to apply to all environments.","anyOf":[{"$ref":"#/x-alt-definitions/environments"},{"$ref":"#/x-alt-definitions/Model19"}]},"buckets":{"description":"An array of bucketSids that this exclusion should apply to.","anyOf":[{"$ref":"#/x-alt-definitions/buckets"},{"$ref":"#/x-alt-definitions/Model21"}]}},"required":["criteria"]},"Model17":{"type":"string","description":"The role applied to the API token","enum":["ingest","administrator","user"]},"Model18":{"type":"object","properties":{"name":{"type":"string","description":"The name of the API token"},"role":{"$ref":"#/components/schemas/Model17"},"environmentSid":{"type":"string","description":"environmentSid","pattern":"^[a-zA-Z0-9]{6}$"}},"required":["name","role","environmentSid"]},"API Token":{"type":"object","properties":{"sid":{"type":"string","description":"The actual API token"},"accountSid":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"environmentSid":{"type":"string","description":"environmentSid","nullable":true,"pattern":"^[a-zA-Z0-9]{6}$"},"name":{"type":"string","description":"Name of the API token"},"role":{"$ref":"#/components/schemas/role"},"token":{"type":"string","description":"The API token"},"createdAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"updatedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}},"lastUsedAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","nullable":true,"pattern":".*Z","x-format":{"isoDate":true}}},"required":["sid","accountSid","environmentSid","name","role","createdAt","updatedAt"]},"Model19":{"type":"object","description":"Freeform key/value metadata (e.g. commitSha, branch, imageTag)","nullable":true},"Model20":{"type":"array","description":"Bucket sids this event applies to. Defaults to [\"*\"] (all).","items":{"type":"string"}},"Model21":{"type":"array","description":"Environment sids this event applies to. Defaults to [\"*\"] (all).","items":{"type":"string"}},"Model22":{"type":"object","properties":{"type":{"type":"string","description":"Event type (e.g. deployment, incident, config_change, scale, custom)","maxLength":100},"name":{"type":"string","description":"Human-readable event name","maxLength":255},"description":{"type":"string","description":"Optional longer description","nullable":true},"source":{"type":"string","description":"Source of the event (e.g. github_actions, gitlab_ci, jenkins, manual)","nullable":true,"maxLength":100},"metadata":{"$ref":"#/components/schemas/Model19"},"bucketSids":{"$ref":"#/components/schemas/Model20"},"environmentSids":{"$ref":"#/components/schemas/Model21"},"startedAt":{"type":"string","description":"When the event started. Defaults to now.","x-format":{"isoDate":true}},"endedAt":{"type":"string","description":"When the event ended. Null for point-in-time events.","nullable":true,"x-format":{"isoDate":true}}},"required":["type","name"]},"view":{"type":"string","description":"The type of embed view.","default":"request-log","enum":["request-log"]},"filters":{"type":"object","description":"Filters locked into the embed token.","default":{},"properties":{"environmentSid":{"type":"string","description":"Environment to filter by.","nullable":true},"criteria":{"type":"string","description":"Search criteria string (same format as the request log API).","nullable":true},"streamViewSid":{"type":"string","description":"Stream view to use for filtering.","nullable":true}}},"theme":{"type":"string","description":"Theme preference for the embed.","default":"light","enum":["light","dark","auto"]},"Model23":{"type":"object","properties":{"view":{"$ref":"#/components/schemas/view"},"bucketSid":{"type":"string","description":"The bucket to scope the embed to."},"filters":{"$ref":"#/components/schemas/filters"},"ttl":{"type":"integer","description":"Token time-to-live in seconds (min 60, max 86400).","default":3600,"minimum":60,"maximum":86400},"theme":{"$ref":"#/components/schemas/theme"}},"required":["bucketSid"]},"Embed Token Response":{"type":"object","properties":{"token":{"type":"string","description":"The signed embed JWT."},"expiresAt":{"type":"string","description":"ISO timestamp when the token expires.","x-format":{"isoDate":true}}},"required":["token","expiresAt"]},"Model24":{"type":"object","properties":{"name":{"type":"string","description":"The name of the stream view"},"icon":{"$ref":"#/components/schemas/icon"},"criteria":{"type":"string","description":"The search criteria for the stream view"}},"required":["name","criteria"]},"Model25":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"details":{"type":"string","nullable":true}},"required":["name"]},"Model26":{"type":"object","properties":{"requestSid":{"type":"string"},"name":{"type":"string","nullable":true,"maxLength":255}},"required":["requestSid"]},"expiresIn":{"type":"string","default":"never","enum":["24h","7d","30d","never"]},"Model27":{"type":"object","nullable":true,"properties":{"name":{"type":"string","nullable":true,"maxLength":255},"expiresIn":{"$ref":"#/components/schemas/expiresIn"}}},"Model28":{"type":"object","properties":{"name":{"type":"string","description":"The name of the workflow."},"streamViewSid":{"type":"string","description":"The streamViewSid that this workflow is associated with.","nullable":true,"pattern":"^sv_[a-zA-Z0-9]{27}$"},"environmentSid":{"type":"string","description":"The environmentSid that this workflow is associated with.","pattern":"^[a-z0-9]{6}$"},"isPerEnvironment":{"type":"boolean","description":"Indicates if this workflow can be edited on a per enviornment basis.","default":false},"signin":{"type":"boolean","description":"Returns the signin information for the user that is sending the create request.","default":true}},"required":["name","environmentSid"]},"Model29":{"type":"object","nullable":true,"properties":{"name":{"type":"string","nullable":true,"maxLength":255},"expiresIn":{"$ref":"#/components/schemas/expiresIn"}}},"Model30":{"type":"object"},"Model31":{"type":"array","items":{"type":"string"}},"Model32":{"type":"array","items":{"type":"string"}},"Model33":{"type":"object","properties":{"type":{"type":"string","maxLength":100},"name":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"maxLength":100},"metadata":{"$ref":"#/components/schemas/Model30"},"bucketSids":{"$ref":"#/components/schemas/Model31"},"environmentSids":{"$ref":"#/components/schemas/Model32"},"startedAt":{"type":"string","x-format":{"isoDate":true}},"endedAt":{"type":"string","nullable":true,"x-format":{"isoDate":true}}}},"Exclusion Update Payload":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the exclusion is currently enabled or not.","default":true},"description":{"type":"string","description":"A short description for the exclusion.","nullable":true},"criteria":{"type":"string","description":"The criteria that should be used to exclude requests."},"environments":{"description":"An array of environments to apply this to. This should be omitted to apply to all environments.","anyOf":[{"$ref":"#/x-alt-definitions/environments"},{"$ref":"#/x-alt-definitions/Model23"}]},"buckets":{"description":"An array of bucketSids that this exclusion should apply to.","anyOf":[{"$ref":"#/x-alt-definitions/buckets"},{"$ref":"#/x-alt-definitions/Model25"}]}},"required":["criteria"]},"Model34":{"type":"object","properties":{"name":{"type":"string","description":"The name of the bucket"},"verifySslCerts":{"type":"boolean","description":"If SSL Certificates should be verified as valid and trusted."}},"required":["name","verifySslCerts"]},"Model35":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the redaction is currently enabled or not.","default":true},"description":{"type":"string","description":"A short description for the redaction.","nullable":true},"pattern":{"type":"string","description":"The pattern that will be applied to find the data to redact.","nullable":true},"redactAt":{"$ref":"#/components/schemas/redactAt"},"type":{"type":"string","description":"The type of redaction, this can be one of the predefined types or custom."},"level":{"$ref":"#/components/schemas/level"},"applyTo":{"$ref":"#/components/schemas/applyTo"},"environments":{"description":"An array of environments to apply this to. This should be omitted to apply to all environments.","anyOf":[{"$ref":"#/x-alt-definitions/environments"},{"$ref":"#/x-alt-definitions/Model27"}]},"buckets":{"description":"An array of bucketSids that this redaction should apply to.","anyOf":[{"$ref":"#/x-alt-definitions/buckets"},{"$ref":"#/x-alt-definitions/Model29"}]},"scopes":{"description":"The scopes for the redaction.","anyOf":[{"$ref":"#/x-alt-definitions/Model30"},{"$ref":"#/x-alt-definitions/Model32"}]}},"required":["enabled","pattern","redactAt","type","level","applyTo"]},"Model36":{"type":"string","description":"The role applied to the API token","enum":["ingest","administrator","user"]},"Model37":{"type":"object","properties":{"name":{"type":"string","description":"The name of the API token"},"role":{"$ref":"#/components/schemas/Model36"}},"required":["name","role"]},"Model38":{"type":"array","description":"Updated bucket SIDs (empty = all buckets)","items":{"type":"string"}},"Model39":{"type":"object","properties":{"name":{"type":"string","description":"Updated name"},"bucketSids":{"$ref":"#/components/schemas/Model38"}}},"Model40":{"type":"object","properties":{"name":{"type":"string","description":"The name of the stream view"},"criteria":{"type":"string","description":"The search criteria for the stream view"},"icon":{"$ref":"#/components/schemas/icon"}},"required":["name","criteria"]},"Model41":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"details":{"type":"string","nullable":true}}},"Model42":{"type":"object","properties":{"name":{"type":"string","nullable":true,"maxLength":255}},"required":["name"]},"API Token Deleted":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the API token"},"deleted":{"type":"boolean","description":"Flag indicating the bucket was successfully deleted."}},"required":["sid","deleted"]},"Redaction Deleted":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the redaction"},"deleted":{"type":"boolean","description":"Flag indicating the redaction was successfully deleted."}},"required":["sid","deleted"]},"Bucket Deleted":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the bucket"},"deleted":{"type":"boolean","description":"Flag indicating the bucket was successfully deleted."}},"required":["sid","deleted"]},"Exclusion Deleted":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the exclusion"},"deleted":{"type":"boolean","description":"Flag indicating the exclusion was successfully deleted."}},"required":["sid","deleted"]},"Event Deleted":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the event"},"deleted":{"type":"boolean","description":"Flag indicating the event was successfully deleted."}},"required":["sid","deleted"]},"Request Deleted":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the request"},"createdAt":{"type":"string","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"deleted":{"type":"boolean","description":"Flag indicating the request was successfully deleted."}},"required":["sid","createdAt","deleted"]},"Stream View Deleted":{"type":"object","properties":{"sid":{"type":"string","description":"Sid of the stream view","pattern":"^sv_[a-zA-Z0-9]{27}$"},"deleted":{"type":"boolean","description":"Flag indicating the stream view was successfully deleted."}},"required":["sid","deleted"]}}},"tags":[],"paths":{"/health":{"get":{"summary":"Health Check","operationId":"getHealth","description":"Health Check","tags":["Utilities"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/mcp":{"get":{"summary":"MCP Streamable HTTP transport - SSE notifications stream.","operationId":"getMcp","tags":["MCP"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"MCP Streamable HTTP transport - stateful JSON-RPC endpoint.","operationId":"postMcp","tags":["MCP"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"MCP Streamable HTTP transport - terminate session.","operationId":"deleteMcp","tags":["MCP"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/platform-health":{"get":{"summary":"Platform Health Check","operationId":"getPlatformhealth","description":"Platform Health Check","tags":["Utilities"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/mcp/sse":{"get":{"summary":"MCP SSE transport - opens an event stream for MCP communication.","operationId":"getMcpSse","tags":["MCP"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/redactions":{"get":{"summary":"Returns all the options for redactions including preset types and scopes.","operationId":"getV1Redactions","tags":["Redactions"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}":{"get":{"summary":"Get the details of an account.","operationId":"getV1AccountsAccountsid","tags":["Account"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/authentication/me":{"get":{"summary":"Returns the user profile information.","operationId":"getV1AuthenticationMe","tags":["Authentication"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/authentication/signout":{"get":{"summary":"Signs the user our of their session","operationId":"getV1AuthenticationSignout","tags":["Authentication"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/authentication/verify":{"get":{"summary":"Verifies an authentication token.","operationId":"getV1AuthenticationVerify","tags":["Authentication"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Verifies%20a%20token%20is%20valid."}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/embed/requests":{"get":{"summary":"Returns request log data for an embed. Authenticated via embed JWT.","operationId":"getV1EmbedRequests","parameters":[{"name":"from","in":"query","schema":{"type":"string","description":"Cursor for pagination (requestSid of last item).","nullable":true},"description":"Cursor for pagination (requestSid of last item)."},{"name":"limit","in":"query","schema":{"type":"integer","description":"Number of records to return.","default":25,"minimum":1,"maximum":100},"description":"Number of records to return."}],"tags":["Embeds"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/shared/{shareToken}":{"get":{"summary":"Returns a shared request by its public share token. No authentication required.","operationId":"getV1SharedSharetoken","parameters":[{"name":"shareToken","in":"path","schema":{"type":"string"},"required":true}],"tags":["Request Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/shares":{"get":{"summary":"Returns all active shared links for an account.","operationId":"getV1AccountsAccountsidShares","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true}],"tags":["Request Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/apiTokens":{"get":{"summary":"Get API token details","operationId":"getV1AccountsAccountsidApitokens","description":"Returns the API token information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["API Tokens"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API%20Token%20Collection%20Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a new API token associated to an account.","operationId":"postV1AccountsAccountsidApitokens","description":"Returns the API token information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["API Tokens"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model18"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API%20Token"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/exclusions":{"get":{"summary":"List all exclusions for an account.","operationId":"getV1AccountsAccountsidExclusions","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["Exclusions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exclusion%20Collection%20Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a new exclusion for an account based on scope and environment.","operationId":"postV1AccountsAccountsidExclusions","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["Exclusions"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exclusion%20Creation%20Payload"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exclusion"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets":{"get":{"summary":"Get bucket details","operationId":"getV1AccountsAccountsidBuckets","description":"Returns the bucket information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["Buckets"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bucket%20Collection%20Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a new bucket associated to an account.","operationId":"postV1AccountsAccountsidBuckets","description":"Returns the bucket information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["Buckets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model16"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bucket"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/redactions":{"get":{"summary":"Get redaction details","operationId":"getV1AccountsAccountsidRedactions","description":"Returns the redaction information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["Redactions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redaction%20Collection%20Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a new data redaction for the bucket.","operationId":"postV1AccountsAccountsidRedactions","description":"Returns the redaction.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["Redactions"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redaction%20Payload"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redaction"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/environments":{"get":{"summary":"Returns a list of environments","operationId":"getV1AccountsAccountsidEnvironments","tags":["Environments"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a new environment associated to a account.","operationId":"postV1AccountsAccountsidEnvironments","tags":["Environments"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/events":{"get":{"summary":"Returns a list of events for an account.","operationId":"getV1AccountsAccountsidEvents","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"type","in":"query","schema":{"type":"string","description":"Filter by event type"},"description":"Filter by event type"},{"name":"startTime","in":"query","schema":{"type":"string","description":"Filter events starting from this time","x-format":{"isoDate":true}},"description":"Filter events starting from this time"},{"name":"endTime","in":"query","schema":{"type":"string","description":"Filter events up to this time","x-format":{"isoDate":true}},"description":"Filter events up to this time"},{"name":"bucketSid","in":"query","schema":{"type":"string","description":"Filter events that apply to this bucket"},"description":"Filter events that apply to this bucket"},{"name":"environmentSid","in":"query","schema":{"type":"string","description":"Filter events that apply to this environment"},"description":"Filter events that apply to this environment"},{"name":"limit","in":"query","schema":{"type":"number","description":"Max number of results to return","default":50,"maximum":100},"description":"Max number of results to return"}],"tags":["Events"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event%20Collection%20Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a new event marker (e.g. deployment, incident, config change).","operationId":"postV1AccountsAccountsidEvents","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["Events"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model22"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/mcpTokens":{"get":{"summary":"Returns all MCP tokens associated to an account.","operationId":"getV1AccountsAccountsidMcptokens","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["MCP Tokens"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a new MCP token associated to an account.","operationId":"postV1AccountsAccountsidMcptokens","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["MCP Tokens"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model15"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/mfaPolicy":{"get":{"summary":"Get the MFA enforcement policy for an account.","operationId":"getV1AccountsAccountsidMfapolicy","tags":["MFA"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Update the MFA enforcement policy for an account.","operationId":"putV1AccountsAccountsidMfapolicy","tags":["MFA"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/collection-shares":{"get":{"summary":"Returns all active shared collection links for an account.","operationId":"getV1AccountsAccountsidCollectionshares","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true}],"tags":["Collection Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/admin/betterstack/backfill-source-tables":{"get":{"summary":"Backfill betterstack_source_table for accounts that have a source_id but are missing the table name.","operationId":"getV1AdminBetterstackBackfillsourcetables","tags":["Admin","BetterStack"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/admin/betterstack/provision-all":{"get":{"summary":"Provision BetterStack sources for all accounts that do not yet have one.","operationId":"getV1AdminBetterstackProvisionall","tags":["Admin","BetterStack"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/buckets/{bucketSid}/sdk":{"get":{"summary":"Returns the SDK settings for the given bucket based on the ingestion key.","operationId":"getV1BucketsBucketsidSdk","parameters":[{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true},{"name":"redactAt","in":"query","schema":{"type":"string","description":"Where the data should be redacted.","enum":["client","server"]},"description":"Where the data should be redacted.","required":true},{"name":"clientId","in":"query","schema":{"type":"string","description":"The Id of the client attempting to get the SDK settings."},"description":"The Id of the client attempting to get the SDK settings.","required":true}],"tags":["Buckets","Redactions","SDK"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/embed/requests/{requestSid}":{"get":{"summary":"Returns a single request detail for an embed. Authenticated via embed JWT.","operationId":"getV1EmbedRequestsRequestsid","parameters":[{"name":"requestSid","in":"path","schema":{"type":"string","description":"requestSid","pattern":"^req_[a-zA-Z0-9]{27}$"},"description":"requestSid","required":true}],"tags":["Embeds"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/shared/collections/{shareToken}":{"get":{"summary":"Returns a shared collection by its public share token. No authentication required.","operationId":"getV1SharedCollectionsSharetoken","parameters":[{"name":"shareToken","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collection Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/workflows/{externalWorkflowId}/requests":{"get":{"summary":"Returns up to the last 10 requests that are associated with a workflow based on the external workflow id.","operationId":"getV1WorkflowsExternalworkflowidRequests","tags":["Workflows"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/mcpTokens/{mcpTokenSid}":{"get":{"summary":"Returns a single MCP token.","operationId":"getV1AccountsAccountsidMcptokensMcptokensid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"mcpTokenSid","in":"path","schema":{"type":"string","description":"mcpTokenSid","pattern":"^mcp_[a-zA-Z0-9]{27}$"},"description":"mcpTokenSid","required":true}],"tags":["MCP Tokens"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Updates an existing MCP token.","operationId":"putV1AccountsAccountsidMcptokensMcptokensid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"mcpTokenSid","in":"path","schema":{"type":"string","description":"mcpTokenSid","pattern":"^mcp_[a-zA-Z0-9]{27}$"},"description":"mcpTokenSid","required":true}],"tags":["MCP Tokens"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model39"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Revokes an MCP token.","operationId":"deleteV1AccountsAccountsidMcptokensMcptokensid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"mcpTokenSid","in":"path","schema":{"type":"string","description":"mcpTokenSid","pattern":"^mcp_[a-zA-Z0-9]{27}$"},"description":"mcpTokenSid","required":true}],"tags":["MCP Tokens"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/events/{eventSid}":{"get":{"summary":"Get the details of a single event.","operationId":"getV1AccountsAccountsidEventsEventsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"eventSid","in":"path","schema":{"type":"string","description":"eventSid","pattern":"^evt_[a-zA-Z0-9]{27}$"},"description":"eventSid","required":true}],"tags":["Events"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Updates an existing event.","operationId":"putV1AccountsAccountsidEventsEventsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"eventSid","in":"path","schema":{"type":"string","description":"eventSid","pattern":"^evt_[a-zA-Z0-9]{27}$"},"description":"eventSid","required":true}],"tags":["Events"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model33"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes an event.","operationId":"deleteV1AccountsAccountsidEventsEventsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"eventSid","in":"path","schema":{"type":"string","description":"eventSid","pattern":"^evt_[a-zA-Z0-9]{27}$"},"description":"eventSid","required":true}],"tags":["Events"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event%20Deleted"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/environments/{environmentSid}":{"get":{"summary":"Get the details of an environment.","operationId":"getV1AccountsAccountsidEnvironmentsEnvironmentsid","tags":["Environments"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Updates an environment","operationId":"putV1AccountsAccountsidEnvironmentsEnvironmentsid","tags":["Environments"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes an environment and all associated items.","operationId":"deleteV1AccountsAccountsidEnvironmentsEnvironmentsid","tags":["Environments"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/metrics/responseTime":{"get":{"summary":"Returns the request throughput information for an account, can be further filtered.","operationId":"getV1AccountsAccountsidMetricsResponsetime","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"startTime","in":"query","schema":{"type":"string","description":"The start date/time for the data that should be returned.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"The start date/time for the data that should be returned.","required":true},{"name":"endTime","in":"query","schema":{"type":"string","description":"The end date/time for the data that should be returned.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"The end date/time for the data that should be returned.","required":true},{"name":"environmentSid","in":"query","schema":{"type":"string","description":"Sid of the environment","pattern":"^[a-z0-9]{6}$"},"description":"Sid of the environment","required":true},{"name":"bucketSid","in":"query","schema":{"type":"string","description":"A BucketSid to filter the data by."},"description":"A BucketSid to filter the data by."},{"name":"apiSid","in":"query","schema":{"type":"string","description":"An ApiSid to filter the data by.","pattern":"^api_[a-zA-Z0-9]{27}$"},"description":"An ApiSid to filter the data by."},{"name":"pathSid","in":"query","schema":{"type":"string","description":"A PathSid to filter the data by.","pattern":"^pth_[a-zA-Z0-9]{27}$"},"description":"A PathSid to filter the data by."},{"name":"resolution","in":"query","schema":{"type":"string","description":"The resolution that the data should be grouped and returned in.","default":"10min","enum":["1min","10min","1hr","2hr","1d","1mo"]},"description":"The resolution that the data should be grouped and returned in."}],"tags":["Metrics"],"responses":{"200":{"description":"The data structure that throuput data be reported back with.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseTimeResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/metrics/summary":{"get":{"summary":"Returns the summary information for an account, can be further filtered.","operationId":"getV1AccountsAccountsidMetricsSummary","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"startTime","in":"query","schema":{"type":"string","description":"The start date/time for the data that should be returned.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"The start date/time for the data that should be returned.","required":true},{"name":"endTime","in":"query","schema":{"type":"string","description":"The end date/time for the data that should be returned.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"The end date/time for the data that should be returned.","required":true},{"name":"environmentSid","in":"query","schema":{"type":"string","description":"Sid of the environment","pattern":"^[a-z0-9]{6}$"},"description":"Sid of the environment","required":true},{"name":"bucketSid","in":"query","schema":{"type":"string","description":"A BucketSid to filter the data by."},"description":"A BucketSid to filter the data by."},{"name":"apiSid","in":"query","schema":{"type":"string","description":"An ApiSid to filter the data by.","pattern":"^api_[a-zA-Z0-9]{27}$"},"description":"An ApiSid to filter the data by."},{"name":"pathSid","in":"query","schema":{"type":"string","description":"A PathSid to filter the data by.","pattern":"^pth_[a-zA-Z0-9]{27}$"},"description":"A PathSid to filter the data by."}],"tags":["Metrics"],"responses":{"200":{"description":"The data structure that each of the metrics will be reported back with.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsSummary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}":{"get":{"summary":"Get the details of a single bucket","operationId":"getV1AccountsAccountsidBucketsBucketsid","description":"Returns the bucket information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true}],"tags":["Buckets"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bucket"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Updates the details of a single bucket","operationId":"putV1AccountsAccountsidBucketsBucketsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true}],"tags":["Buckets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model34"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bucket"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes as single bucket and all associated requests.","operationId":"deleteV1AccountsAccountsidBucketsBucketsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true}],"tags":["Buckets"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bucket%20Deleted"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/realtime/authentication":{"get":{"summary":"Get the details of an account.","operationId":"getV1AccountsAccountsidRealtimeAuthentication","tags":["Account"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/redactions/{redactionSid}":{"get":{"summary":"Get redaction details","operationId":"getV1AccountsAccountsidRedactionsRedactionsid","description":"Returns the redaction information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"redactionSid","in":"path","schema":{"type":"string","description":"redactionSid","pattern":"^red_[a-zA-Z0-9]{27}$"},"description":"redactionSid","required":true}],"tags":["Redactions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redaction"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Updates the details of a single redaction","operationId":"putV1AccountsAccountsidRedactionsRedactionsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"redactionSid","in":"path","schema":{"type":"string","description":"redactionSid","pattern":"^red_[a-zA-Z0-9]{27}$"},"description":"redactionSid","required":true}],"tags":["Redactions"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model35"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redaction"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes as single redaction.","operationId":"deleteV1AccountsAccountsidRedactionsRedactionsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"redactionSid","in":"path","schema":{"type":"string","description":"redactionSid","pattern":"^red_[a-zA-Z0-9]{27}$"},"description":"redactionSid","required":true}],"tags":["Redactions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redaction%20Deleted"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/exclusions/{exclusionSid}":{"get":{"summary":"Gets a single exclusion details","operationId":"getV1AccountsAccountsidExclusionsExclusionsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"exclusionSid","in":"path","schema":{"type":"string","description":"exclusionSid","pattern":"^xcl_[a-zA-Z0-9]{27}$"},"description":"exclusionSid","required":true}],"tags":["Exclusions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exclusion"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Updates the details of a single exclusion","operationId":"putV1AccountsAccountsidExclusionsExclusionsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"exclusionSid","in":"path","schema":{"type":"string","description":"exclusionSid","pattern":"^xcl_[a-zA-Z0-9]{27}$"},"description":"exclusionSid","required":true}],"tags":["Exclusions"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exclusion%20Update%20Payload"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exclusion"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes as single exclusion.","operationId":"deleteV1AccountsAccountsidExclusionsExclusionsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"exclusionSid","in":"path","schema":{"type":"string","description":"exclusionSid","pattern":"^xcl_[a-zA-Z0-9]{27}$"},"description":"exclusionSid","required":true}],"tags":["Exclusions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exclusion%20Deleted"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/metrics/throughput":{"get":{"summary":"Returns the request throughput information for an account, can be further filtered.","operationId":"getV1AccountsAccountsidMetricsThroughput","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"startTime","in":"query","schema":{"type":"string","description":"The start date/time for the data that should be returned.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"The start date/time for the data that should be returned.","required":true},{"name":"endTime","in":"query","schema":{"type":"string","description":"The end date/time for the data that should be returned.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"The end date/time for the data that should be returned.","required":true},{"name":"environmentSid","in":"query","schema":{"type":"string","description":"Sid of the environment","pattern":"^[a-z0-9]{6}$"},"description":"Sid of the environment","required":true},{"name":"bucketSid","in":"query","schema":{"type":"string","description":"A BucketSid to filter the data by."},"description":"A BucketSid to filter the data by."},{"name":"apiSid","in":"query","schema":{"type":"string","description":"An ApiSid to filter the data by.","pattern":"^api_[a-zA-Z0-9]{27}$"},"description":"An ApiSid to filter the data by."},{"name":"pathSid","in":"query","schema":{"type":"string","description":"A PathSid to filter the data by.","pattern":"^pth_[a-zA-Z0-9]{27}$"},"description":"A PathSid to filter the data by."},{"name":"resolution","in":"query","schema":{"type":"string","description":"The resolution that the data should be grouped and returned in.","default":"10min","enum":["1min","10min","1hr","2hr","1d","1mo"]},"description":"The resolution that the data should be grouped and returned in."},{"name":"units","in":"query","schema":{"type":"string","description":"Return metric as requests per second (rps) or requests per minute (rpm).","default":"rps","enum":["rps","rpm"]},"description":"Return metric as requests per second (rps) or requests per minute (rpm)."}],"tags":["Metrics"],"responses":{"200":{"description":"The data structure that throuput data be reported back with.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThroughputResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/metrics/trafficPunchcard":{"get":{"summary":"Returns the request throughput information for an account, can be further filtered.","operationId":"getV1AccountsAccountsidMetricsTrafficpunchcard","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"startTime","in":"query","schema":{"type":"string","description":"The start date/time for the data that should be returned.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"The start date/time for the data that should be returned.","required":true},{"name":"endTime","in":"query","schema":{"type":"string","description":"The end date/time for the data that should be returned.","example":"1970-01-01T00:00:00.000Z","pattern":".*Z","x-format":{"isoDate":true}},"description":"The end date/time for the data that should be returned.","required":true},{"name":"environmentSid","in":"query","schema":{"type":"string","description":"Sid of the environment","pattern":"^[a-z0-9]{6}$"},"description":"Sid of the environment","required":true},{"name":"bucketSid","in":"query","schema":{"type":"string","description":"A BucketSid to filter the data by."},"description":"A BucketSid to filter the data by."},{"name":"apiSid","in":"query","schema":{"type":"string","description":"An ApiSid to filter the data by.","pattern":"^api_[a-zA-Z0-9]{27}$"},"description":"An ApiSid to filter the data by."},{"name":"pathSid","in":"query","schema":{"type":"string","description":"A PathSid to filter the data by.","pattern":"^pth_[a-zA-Z0-9]{27}$"},"description":"A PathSid to filter the data by."},{"name":"resolution","in":"query","schema":{"type":"string","description":"The resolution that the data should be grouped and returned in.","default":"10min","enum":["1min","10min","1hr","2hr","1d","1mo"]},"description":"The resolution that the data should be grouped and returned in."}],"tags":["Metrics"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/apiTokens/{apiTokenSid}":{"get":{"summary":"Get the details of a single API token","operationId":"getV1AccountsAccountsidApitokensApitokensid","description":"Returns the API token information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"Accountn sid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"Accountn sid","required":true},{"name":"apiTokenSid","in":"path","schema":{"type":"string","description":"API token sid"},"description":"API token sid","required":true}],"tags":["API Tokens"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API%20token"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Updates the details of a single API token","operationId":"putV1AccountsAccountsidApitokensApitokensid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"apiTokenSid","in":"path","schema":{"type":"string","description":"apiTokenSid"},"description":"apiTokenSid","required":true}],"tags":["API Tokens"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model37"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API token"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes as single API token.","operationId":"deleteV1AccountsAccountsidApitokensApitokensid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"apiTokenSid","in":"path","schema":{"type":"string","description":"apiTokenSid"},"description":"apiTokenSid","required":true}],"tags":["API Tokens"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API%20Token%20Deleted"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/collection-shares":{"get":{"summary":"Returns all active shared collection links for a bucket.","operationId":"getV1AccountsAccountsidBucketsBucketsidCollectionshares","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collection Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/collections":{"get":{"summary":"Returns all collections for a bucket.","operationId":"getV1AccountsAccountsidBucketsBucketsidCollections","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collections"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a new collection.","operationId":"postV1AccountsAccountsidBucketsBucketsidCollections","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collections"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model25"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/streamViews":{"get":{"summary":"Get Stream View details","operationId":"getV1AccountsAccountsidBucketsBucketsidStreamviews","description":"Returns the stream view information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true}],"tags":["Stream Views"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stream%20View%20Collection%20Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a new stream view associated to a bucket.","operationId":"postV1AccountsAccountsidBucketsBucketsidStreamviews","description":"Creates a stream view.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true}],"tags":["Stream Views"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model24"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stream%20View"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/requests":{"get":{"summary":"Lists all the requests in the bucket.","operationId":"getV1AccountsAccountsidBucketsBucketsidRequests","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true}],"tags":["Requests"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request%20Collection%20Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/shares":{"get":{"summary":"Returns all active shared links for a bucket.","operationId":"getV1AccountsAccountsidBucketsBucketsidShares","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Request Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/requests/{requestSid}":{"get":{"summary":"Get the details of a single bucket","operationId":"getV1AccountsAccountsidBucketsBucketsidRequestsRequestsid","description":"Returns the bucket information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true},{"name":"requestSid","in":"path","schema":{"type":"string","description":"requestSids","pattern":"^req_[a-zA-Z0-9]{27}$"},"description":"requestSids","required":true}],"tags":["Requests"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model13"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Updates the details of a single request","operationId":"putV1AccountsAccountsidBucketsBucketsidRequestsRequestsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true},{"name":"requestSid","in":"path","schema":{"type":"string","description":"requestSids","pattern":"^req_[a-zA-Z0-9]{27}$"},"description":"requestSids","required":true}],"tags":["Requests"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model13"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes as single request.","operationId":"deleteV1AccountsAccountsidBucketsBucketsidRequestsRequestsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true},{"name":"requestSid","in":"path","schema":{"type":"string","description":"requestSids","pattern":"^req_[a-zA-Z0-9]{27}$"},"description":"requestSids","required":true}],"tags":["Requests"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request%20Deleted"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/streamViews/{streamViewSid}":{"get":{"summary":"Get the details of a single stream view","operationId":"getV1AccountsAccountsidBucketsBucketsidStreamviewsStreamviewsid","description":"Returns the stream view information.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true},{"name":"streamViewSid","in":"path","schema":{"type":"string","description":"streamViewSid","pattern":"^sv_[a-zA-Z0-9]{27}$"},"description":"streamViewSid","required":true}],"tags":["Stream Views"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stream%20View"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Updates the details of a single stream view","operationId":"putV1AccountsAccountsidBucketsBucketsidStreamviewsStreamviewsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true},{"name":"streamViewSid","in":"path","schema":{"type":"string","description":"streamViewSid","pattern":"^sv_[a-zA-Z0-9]{27}$"},"description":"streamViewSid","required":true}],"tags":["Stream Views"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model40"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stream%20View"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes a single stream view.","operationId":"deleteV1AccountsAccountsidBucketsBucketsidStreamviewsStreamviewsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true},{"name":"streamViewSid","in":"path","schema":{"type":"string","description":"streamViewSid","pattern":"^sv_[a-zA-Z0-9]{27}$"},"description":"streamViewSid","required":true}],"tags":["Stream Views"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stream%20View%20Deleted"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/collections/{collectionSid}":{"get":{"summary":"Returns a single collection with its requests.","operationId":"getV1AccountsAccountsidBucketsBucketsidCollectionsCollectionsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collections"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"put":{"summary":"Updates a collection.","operationId":"putV1AccountsAccountsidBucketsBucketsidCollectionsCollectionsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collections"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model41"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Soft-deletes a collection.","operationId":"deleteV1AccountsAccountsidBucketsBucketsidCollectionsCollectionsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collections"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/collections/{collectionSid}/share":{"get":{"summary":"Returns the active share link for a collection.","operationId":"getV1AccountsAccountsidBucketsBucketsidCollectionsCollectionsidShare","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collection Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a share link for a collection.","operationId":"postV1AccountsAccountsidBucketsBucketsidCollectionsCollectionsidShare","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collection Sharing"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model29"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Revokes the share link for a collection.","operationId":"deleteV1AccountsAccountsidBucketsBucketsidCollectionsCollectionsidShare","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collection Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/requests/{requestSid}/share":{"get":{"summary":"Returns the active share link for a request.","operationId":"getV1AccountsAccountsidBucketsBucketsidRequestsRequestsidShare","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"requestSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Request Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a share link for a request.","operationId":"postV1AccountsAccountsidBucketsBucketsidRequestsRequestsidShare","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"requestSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Request Sharing"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model27"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Revokes the share link for a request.","operationId":"deleteV1AccountsAccountsidBucketsBucketsidRequestsRequestsidShare","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"requestSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Request Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/streamViews/{streamViewSid}/requests":{"get":{"summary":"Returns the most recent 5 requests from the stream view. This will include the full request payload data.","operationId":"getV1AccountsAccountsidBucketsBucketsidStreamviewsStreamviewsidRequests","tags":["Stream Views"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/environments/{environmentSid}/buckets/{bucketSid}/workflows":{"get":{"summary":"Get lists workflows","operationId":"getV1AccountsAccountsidEnvironmentsEnvironmentsidBucketsBucketsidWorkflows","description":"Returns the workflow information.","tags":["Workflows"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Creates a new workflow associated to a bucket.","operationId":"postV1AccountsAccountsidEnvironmentsEnvironmentsidBucketsBucketsidWorkflows","description":"Creates a new workflow.","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true},{"name":"environmentSid","in":"path","schema":{"type":"string","description":"environmentSid"},"description":"environmentSid","required":true},{"name":"bucketSid","in":"path","schema":{"type":"string","description":"bucketSid"},"description":"bucketSid","required":true}],"tags":["Workflows"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model28"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/environments/{environmentSid}/buckets/{bucketSid}/workflows/authentication":{"get":{"summary":"Signs the user into the workflow UI.","operationId":"getV1AccountsAccountsidEnvironmentsEnvironmentsidBucketsBucketsidWorkflowsAuthentication","description":"Signs the user into the workflow UI.","tags":["Workflows","Authentication"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/environments/{environmentSid}/buckets/{bucketSid}/workflows/{workflowSid}":{"get":{"summary":"Get the details of a single workflow","operationId":"getV1AccountsAccountsidEnvironmentsEnvironmentsidBucketsBucketsidWorkflowsWorkflowsid","description":"Returns the workflow information.","tags":["Workflows"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes a workflow.","operationId":"deleteV1AccountsAccountsidEnvironmentsEnvironmentsidBucketsBucketsidWorkflowsWorkflowsid","tags":["Workflows"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/mcp/sse/message":{"post":{"summary":"MCP SSE transport - receives JSON-RPC messages.","operationId":"postMcpSseMessage","tags":["MCP"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/authentication/mfa/enroll":{"post":{"summary":"Confirm MFA enrollment by verifying the first TOTP code.","operationId":"postV1AuthenticationMfaEnroll","tags":["MFA"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/authentication/mfa/setup":{"post":{"summary":"Generate a new TOTP secret and QR code for MFA enrollment.","operationId":"postV1AuthenticationMfaSetup","tags":["MFA"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/authentication/mfa/verify":{"post":{"summary":"Verify a TOTP or backup code during login.","operationId":"postV1AuthenticationMfaVerify","tags":["MFA"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/embeds/token":{"post":{"summary":"Creates a signed embed token with locked-in filters.","operationId":"postV1AccountsAccountsidEmbedsToken","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","description":"accountSid","pattern":"^acc_[a-zA-Z0-9]{27}$"},"description":"accountSid","required":true}],"tags":["Embeds"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model23"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Embed%20Token%20Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/collections/{collectionSid}/requests":{"post":{"summary":"Adds a request to a collection.","operationId":"postV1AccountsAccountsidBucketsBucketsidCollectionsCollectionsidRequests","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collections"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model26"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/webhooks":{"put":{"summary":"Updates the status of a webhook","operationId":"putV1Webhooks","tags":["Webhooks"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Deletes a webhook","operationId":"deleteV1Webhooks","tags":["Webhooks"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/workflows/{workflowSid}/associations":{"put":{"summary":"Get the details of a workflow.","operationId":"putV1AccountsAccountsidBucketsBucketsidWorkflowsWorkflowsidAssociations","description":"Returns the workflow information.","tags":["Workflows"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/buckets/{bucketSid}/collections/{collectionSid}/requests/{collectionRequestSid}":{"put":{"summary":"Updates the name of a request within a collection.","operationId":"putV1AccountsAccountsidBucketsBucketsidCollectionsCollectionsidRequestsCollectionrequestsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionRequestSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collections"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model42"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Removes a request from a collection.","operationId":"deleteV1AccountsAccountsidBucketsBucketsidCollectionsCollectionsidRequestsCollectionrequestsid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"bucketSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionSid","in":"path","schema":{"type":"string"},"required":true},{"name":"collectionRequestSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collections"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/authentication/mfa":{"delete":{"summary":"Disable MFA for the current user.","operationId":"deleteV1AuthenticationMfa","tags":["MFA"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/shares/{shareSid}":{"delete":{"summary":"Revokes a shared link by its SID.","operationId":"deleteV1AccountsAccountsidSharesSharesid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"shareSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Request Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts/{accountSid}/collection-shares/{shareSid}":{"delete":{"summary":"Revokes a shared collection link by its SID.","operationId":"deleteV1AccountsAccountsidCollectionsharesSharesid","parameters":[{"name":"accountSid","in":"path","schema":{"type":"string","pattern":"^acc_[a-zA-Z0-9]{27}$"},"required":true},{"name":"shareSid","in":"path","schema":{"type":"string"},"required":true}],"tags":["Collection Sharing"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}}},"x-alt-definitions":{"buckets":{"type":"array","items":{"type":"string","x-convert":{"case":"lower"}}},"Model1":{"type":"string","enum":["*"]},"Model2":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model1"}},"environments":{"type":"array","items":{"type":"string","x-constraint":{"length":6},"x-convert":{"case":"lower"}}},"Model3":{"type":"string","enum":["*"]},"Model4":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model3"}},"Model5":{"type":"string","enum":["*"]},"Model6":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model5"}},"Redaction Scopes":{"type":"string","enum":["request.header","request.body","request.query","response.header","response.body"]},"scopes":{"type":"array","items":{"$ref":"#/x-alt-definitions/Redaction%20Scopes"}},"Model7":{"type":"string","enum":["*"]},"Model8":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model7"}},"Model9":{"type":"string","enum":["*"]},"Model10":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model9"}},"string":{"type":"array","items":{"type":"string"}},"Model11":{"type":"string","enum":["*"]},"Model12":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model11"}},"Model13":{"type":"string","enum":["*"]},"Model14":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model13"}},"Model15":{"type":"array","items":{"$ref":"#/x-alt-definitions/Redaction Scopes"}},"Model16":{"type":"string","enum":["*"]},"Model17":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model16"}},"Model18":{"type":"string","enum":["*"]},"Model19":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model18"}},"Model20":{"type":"string","enum":["*"]},"Model21":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model20"}},"Model22":{"type":"string","enum":["*"]},"Model23":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model22"}},"Model24":{"type":"string","enum":["*"]},"Model25":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model24"}},"Model26":{"type":"string","enum":["*"]},"Model27":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model26"}},"Model28":{"type":"string","enum":["*"]},"Model29":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model28"}},"Model30":{"type":"array","items":{"$ref":"#/x-alt-definitions/Redaction Scopes"}},"Model31":{"type":"string","enum":["*"]},"Model32":{"type":"array","maxItems":1,"items":{"$ref":"#/x-alt-definitions/Model31"}}}}