Explain what would happen - Spacefast Docs

Explain what would happen

Answers “what happens if I call this, and why” for one tool address, without making the call.

GET /v1/connectors/policies/resolve

Authorization

Authorization Bearer token · header required

`Authorization: Bearer ` with an API key (`sfa_` prefix), an OAuth access token, a session token, or a Space machine credential (`sfm_` prefix).

or

Authorization OAuth2 access token · header required

OAuth 2.0 with Spacefast scopes. People use the authorization code flow; machines use client credentials.

Scopes: connectors:read

Query parameters

address string required

min length 1 · max length 512

team string

min length 1 · max length 255

Responses

200 Response for status 200

$schema string

Canonical JSON Schema URL for this response body. The server also sends it in the `Link: rel="describedby"` response header.

data object required

"What happens if I call this, and why" — the answer without making the call.

Show properties Hide properties

address string required

The address that was resolved.

effect string required

What would happen if you called it right now.

Allowed: approve require_approval block

decidedBy object | any required

The rule that decided it; null when the spec default applied.

Show properties Hide properties

Any of:

object

ruleId string required

Policy rule that decided it.

pattern string required

The pattern that matched.

owner string required

Whose rule it is. Team rules are a floor members cannot loosen.

Allowed: team personal

any

any

explanation string required

Why, in a sentence you can put in front of a person.

default Problem details (RFC 9457)

Any 4xx/5xx response is one `application/problem+json` document.

$schema string

Canonical JSON Schema URL for this response body. The server also sends it in the `Link: rel="describedby"` response header.

type string required

URL of the documentation page for this error. Derived from `code`.

title string required

Human-readable name of the error type. Derived from `code`.

status integer required

HTTP status of the response, repeated in the body.

min -9007199254740991 · max 9007199254740991

detail string required

What went wrong in this request.

code string required

Stable snake_case error code. Match on this, not on `detail`.

pointer string

RFC 6901 JSON Pointer to the request field or batch entry that failed, for example `/files/37/path`. Present on validation failures.

details object

Machine-readable context keyed by the error code.

suggestions string[]

Recovery steps safe to show to a person.

next string[]

Commands or API requests to run next, usable as written.

requestId string required

ID of this request, from the `X-Request-Id` header or generated. Quote it when contacting support.

Try it

Server

Base URL https://api.spacefast.com
Custom base URL Overrides the selected server when set.

Authorization

Bearer token Remember on this device Include my values in samples

Parameters

address query * team query

Send

Request

cURL

curl -X GET "https://api.spacefast.com/v1/connectors/policies/resolve?address=string" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://api.spacefast.com/v1/connectors/policies/resolve?address=string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Python

import requests

response = requests.get(
    "https://api.spacefast.com/v1/connectors/policies/resolve?address=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

200 default

{
  "$schema": "http://example.com",
  "data": {
    "address": "string",
    "effect": "approve",
    "decidedBy": {
      "ruleId": "string",
      "pattern": "string",
      "owner": "team"
    },
    "explanation": "string"
  }
}

{
  "$schema": "http://example.com",
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "pointer": "string",
  "details": {
    "property1": null,
    "property2": null
  },
  "suggestions": [
    "string"
  ],
  "next": [
    "string"
  ],
  "requestId": "string"
}