Suites

Get a suite

Returns the suite and its current version.

get/v1/suites/{suiteId}

Request

  • Base URL: https://api.ironfang.com/rig
  • URL: https://api.ironfang.com/rig/v1/suites/{suiteId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Response

The suite and its current version

Example response

{
  "version": {
    "definition": {
      "defaults": {
        "run_ttl": "30m"
      },
      "expectations": [
        {
          "id": "verification_email",
          "match": {
            "subject_contains": "Verify"
          }
        }
      ],
      "resources": {
        "customer_email": {
          "type": "email"
        },
        "shipping_api": {
          "type": "mock_http"
        },
        "stripe_callback": {
          "connector": {
            "route": "stripe"
          },
          "type": "callback"
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.