find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/broad-institute:broad-institute-cromiam-workflows-for-admin-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Terra CromIAM Workflows (for Admin) API
  description: Terra API
  termsOfService: https://app.terra.bio/#terms-of-service
  license:
    name: BSD
    url: http://opensource.org/licenses/BSD-3-Clause
  version: '0.1'
servers:
- url: /
security:
- oidc: []
tags:
- name: CromIAM Workflows (for Admin)
paths:
  /api/workflows/{version}/{id}/releaseHold:
    post:
      tags:
      - CromIAM Workflows (for Admin)
      summary: Request Cromwell to release the hold on a workflow.
      parameters:
      - $ref: '#/components/parameters/versionParam'
      - name: id
        in: path
        description: Workflow ID
        required: true
        schema:
          type: string
      responses:
        200:
          description: Successful Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowStatusResponse'
        400:
          description: Malformed Workflow ID
          content: {}
        403:
          description: Malformed Request
          content: {}
        404:
          description: Workflow ID Not Found
          content: {}
        500:
          description: Internal Error
          content: {}
      x-passthrough: true
      x-passthrough-target: cromiam
      operationId: postApiWorkflowsByVersionByIdReleaseHold
      x-operation-id-source: derived
  /api/workflows/{version}/callcaching/diff:
    get:
      tags:
      - CromIAM Workflows (for Admin)
      summary: Return the hash differential between two calls
      parameters:
      - $ref: '#/components/parameters/versionParam'
      - name: workflowA
        in: query
        description: Workflow Id of the first workflow
        required: true
        schema:
          type: string
      - name: callA
        in: query
        description: Call FQN (including workflow name) of the first call
        required: true
        schema:
          type: string
      - name: indexA
        in: query
        description: Index of the first call
        schema:
          type: number
      - name: workflowB
        in: query
        description: Workflow Id of the second workflow
        required: true
        schema:
          type: string
      - name: callB
        in: query
        description: Call FQN (including workflow name) of the second call
        required: true
        schema:
          type: string
      - name: indexB
        in: query
        description: Index of the second call
        schema:
          type: number
      responses:
        200:
          description: Successful Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowCacheDiffResponse'
        400:
          description: Malformed query parameters
          content: {}
        404:
          description: No matching cache entry
          content: {}
        500:
          description: Internal Error
          content: {}
      operationId: getApiWorkflowsByVersionCallcachingDiff
      x-operation-id-source: derived
components:
  schemas:
    WorkflowCallDiffCallHashDiff:
      type: object
      properties:
        hashKey:
          type: string
        callA:
          type: string
        callB:
          type: string
    WorkflowStatusResponse:
      required:
      - id
      - status
      type: object
      properties:
        id:
          type: string
          description: The identifier of the workflow
        status:
          type: string
          description: The status of the workflow
    WorkflowCallDiff:
      type: object
      properties:
        allowResultReuse:
          type: boolean
        callFqn:
          type: string
        executionStatus:
          type: string
        jobIndex:
          type: number
        workflowId:
          $ref: '#/components/parameters/workflowIdParam'
    WorkflowCacheDiffResponse:
      type: object
      properties:
        callA:
          $ref: '#/components/schemas/WorkflowCallDiff'
        callB:
          $ref: '#/components/schemas/WorkflowCallDiff'
        hashDifferential:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowCallDiffCallHashDiff'
  parameters:
    versionParam:
      name: version
      in: path
      description: Cromwell API Version
      required: true
      schema:
        type: string
        default: v1
    workflowIdParam:
      name: workflowId
      in: path
      description: Workflow ID
      required: true
      schema:
        type: string
  securitySchemes:
    oidc:
      type: oauth2
      x-tokenName: id_token
      flows:
        authorizationCode:
          authorizationUrl: OAUTH_AUTHORIZATION_URL
          scopes: {}
          tokenUrl: OAUTH_TOKEN_URL
    oidc_google_billing_scope:
      type: oauth2
      x-tokenName: id_token
      flows:
        authorizationCode:
          authorizationUrl: OAUTH_AUTHORIZATION_URL_WITH_GOOGLE_BILLING_SCOPE
          scopes: {}
          tokenUrl: OAUTH_TOKEN_URL_WITH_GOOGLE_BILLING_SCOPE