Check a connection against the provider and try minting a token

curl --request POST \
  --url https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "resource_count": 0,
  "state": "<string>",
  "token_minted": true,
  "activated": true,
  "excessPermissions": [
    "<string>"
  ],
  "failure": "<string>",
  "missing_permissions": [
    "<string>"
  ]
}

{
  "code": "invalid_request",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unauthorized",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "forbidden",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "not_found",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "payload_too_large",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unsupported_media_type",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "rate_limit_exceeded",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "internal_error",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "bad_gateway",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "managed_agents_unavailable",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "gateway_timeout",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

Integrations

Check a connection against the provider and try minting a token

Checks a connection against the provider and tries to mint a short-lived access token, returning what the provider reported. A suspended or revoked installation is still HTTP 200 with ok=false, so read that field rather than the status code. For a directly registered connection in the pending state this is also the activation step: the probe performs a fresh mint through the trust the customer granted and, if it succeeds, moves the connection to active and reports activated=true; until then it stays pending and the failure text is the bounded “delegate trust is not active”.

POST

managed-agents

integrations

connections

{connectionId}

probe

Check a connection against the provider and try minting a token

curl --request POST \
  --url https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recursion.labelbox.com/managed-agents/v1/integrations/connections/{connectionId}/probe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "resource_count": 0,
  "state": "<string>",
  "token_minted": true,
  "activated": true,
  "excessPermissions": [
    "<string>"
  ],
  "failure": "<string>",
  "missing_permissions": [
    "<string>"
  ]
}

{
  "code": "invalid_request",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unauthorized",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "forbidden",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "not_found",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "payload_too_large",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "unsupported_media_type",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "rate_limit_exceeded",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "internal_error",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "bad_gateway",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "managed_agents_unavailable",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

{
  "code": "gateway_timeout",
  "message": "<string>",
  "details": {
    "field": "<string>",
    "issues": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": true
  }
}

Authorizations

Authorization

string

header

required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id

string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1

x-organization-id

string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

connectionId

string<uuid>

required

Integration connection id (UUID) as returned by managedAgentsListIntegrationConnections.

Response

Result of a live health check against one integration connection: its refreshed state at the provider, whether a token could be minted, and what is missing if not. A failed check is reported here rather than as an HTTP error.

boolean

required

True only when the connection is active at the provider and a scoped token was successfully minted during this probe. False means the connection cannot currently be used; read failure for why. A probe that fails this way is still an HTTP 200.

resource_count

integer

required

Number of provider resources the connection can authorize, for example selected GitHub repositories. The live probe credential may be narrower when the provider cannot represent the entire connection scope in one token. Zero when no token could be minted.

Required range: -9007199254740991 <= x <= 9007199254740991

state

string

required

Lifecycle of the connection as of this probe: pending (registered, waiting for the customer to grant trust), active (usable), suspended (paused at the provider), or revoked (uninstalled or deleted). Refreshed here, so it can differ from the previously stored value: a pending connection whose trust proved usable is reported active.

token_minted

boolean

required

Whether a scoped credential could actually be issued during this probe. This is the check that predicts whether a session using the connection will work.

activated

boolean

True when this probe moved a pending connection to active by proving its trust with a successful mint. Omitted (false) on every later probe of the same connection.

excessPermissions

string[]

GitHub installation permissions above the launch App contract. Reported, not enforced: reduce the App permissions in GitHub and have installation owners approve the update.

failure

string

Human-readable reason the probe did not succeed, such as a suspended install or a rejected mint. Empty when ok is true.

missing_permissions

string[]

Permissions this service requires that the install has not granted at the required level. Reported, not enforced: accept the provider's pending permission request to clear them.

API reference

Endpoints

Check a connection against the provider and try minting a token

Authorizations

Headers

Path Parameters

Response