components

Find component by ID

Returns a component with given ID

get/components/{id}

Path parameters

idstring required

ID of component to return

Response

successful operation

Example response

{
  "data": {
    "name": "My Component",
    "description": "My Component",
    "access": "public",
    "applicationUid": "3f57d4cc-9a6b-40c9-8db6-0657c116e97c",
    "logo": "https://my-component.com/logo.png",
    "distribution": {
      "type": "docker",
      "image": "openintegrationhub/email",
      "registrySecretId": "5b62c919fd98ea00112d52e7"
    },
    "owners": [
      {
        "id": "123",
        "type": "user"
      }
    ]
  }
}

Changes

Changed in 4 of the 11 revisions of this API.48

    • added the optional property data/active to the response with the 200 status

      response-optional-property-added

    • added the optional property data/id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/isGlobal to the response with the 200 status

      response-optional-property-added

    • added the optional property data/logo to the response with the 200 status

      response-optional-property-added

    • added the optional property data/applicationUid to the response with the 200 status

      response-optional-property-added

  • 77e6b7addc6e43See the full diff
    • the response property data/access became optional for the status 200

      response-property-became-optional

    • the response property data/description became optional for the status 200

      response-property-became-optional

    • the response property data/descriptor became optional for the status 200

      response-property-became-optional

    • the response property data/owners became optional for the status 200

      response-property-became-optional

    • the endpoint scheme security api_key was removed from the API

      api-security-removed

    • added the non-success response with the status 401

      response-non-success-status-added

    • the access response's property default value private was added for the status 200

      response-property-default-value-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog