List Imported Apis

GET
/v1/admin/projects/{project_id}/imported-apis

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Path Parameters

project_id*Project Id
Formatuuid

Query Parameters

limit?Limit

Items per page (default 50, at most 200).

Range1 <= value <= 200
Default50
cursor?|

Opaque next_cursor from the previous page.

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid

Response Body

Successful Response

application/json
  1. response
next_cursor*|

Pass as cursor for the next page; empty at the end.

total?|

Number of matching items, only when cheap to count.

items*array<>
Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/imported-apis'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "imported_api_id": "8784f7aa-d748-459c-8fb0-77a0104ccf90",      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",      "name": "string",      "base_url": "http://example.com",      "document_hash": "string",      "status": "pending_review",      "review": {        "decision": "approve",        "notes": "string",        "reviewer": "string",        "credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",        "reviewed_at": "2019-08-24T14:15:22Z"      },      "operations": [        {          "operation_id": "string",          "method": "GET",          "path": "string",          "effect": "read",          "schema_hash": "string",          "drift": true        }      ],      "created_at": "2019-08-24T14:15:22Z"    }  ]}