Warning
This SDK is DEPRECATED
Routing API requests through StackOne directly to the underlying provider.
proxy_request- Proxy Request (Legacy)⚠️ Deprecated
Proxy Request (Legacy)
⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.
require 'stackone_client'
Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
security: Models::Shared::Security.new(
password: '',
username: ''
)
)
res = s.proxy.proxy_request(proxy_request_body: Models::Shared::ProxyRequestBody.new(
headers: {
'Content-Type' => 'application/json',
},
path: '/employees/directory',
url: 'https://api.sample-integration.com/v1'
), x_account_id: '<id>', prefer: 'heartbeat')
unless res.proxy_response_api_model.nil?
# handle response
end| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
proxy_request_body |
Models::Shared::ProxyRequestBody | ✔️ | The request body | |
x_account_id |
::String | ✔️ | The account identifier | |
prefer |
T.nilable(::String) | ➖ | Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240) | heartbeat |
T.nilable(Models::Operations::StackoneProxyRequestResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::BadRequestResponse | 400 | application/json |
| Models::Errors::UnauthorizedResponse | 401 | application/json |
| Models::Errors::ForbiddenResponse | 403 | application/json |
| Models::Errors::NotFoundResponse | 404 | application/json |
| Models::Errors::RequestTimedOutResponse | 408 | application/json |
| Models::Errors::ConflictResponse | 409 | application/json |
| Models::Errors::PreconditionFailedResponse | 412 | application/json |
| Models::Errors::UnprocessableEntityResponse | 422 | application/json |
| Models::Errors::TooManyRequestsResponse | 429 | application/json |
| Models::Errors::InternalServerErrorResponse | 500 | application/json |
| Models::Errors::NotImplementedResponse | 501 | application/json |
| Models::Errors::BadGatewayResponse | 502 | application/json |
| Errors::APIError | 4XX, 5XX | */* |