Get a specific Bitrise addon

GET /addons/{addon-id}

Show details of a specific Bitrise addon

Path parameters

  • addon-id string Required

    Addon ID

Responses

  • 200

    OK

    Hide response attribute Show response attribute object
    • data object

      Additional properties are allowed.

      Hide data attributes Show data attributes object
      • banner_image string
      • card_header_colors array[string]
      • categories array[string]
      • description string
      • documentation_url string
      • has_ui boolean
      • icon string
      • id string
      • is_beta boolean
      • plans array[object]
        Hide plans attributes Show plans attributes object
        • features array[object]
          Hide features attributes Show features attributes object
          • available boolean
          • description string
          • quantity string
        • id string
        • name string
        • price integer
      • platforms array[string]
      • preview_images array[string]
      • setup_guide object

        Additional properties are allowed.

        Hide setup_guide attributes Show setup_guide attributes object
        • instructions array[object]
          Hide instructions attributes Show instructions attributes object
          • card_content string
          • description string
          • type string
        • notification string
      • subtitle string
      • summary string
      • title string
  • 400

    Bad Request

    Hide response attribute Show response attribute object
    • message string
  • 401

    Unauthorized

    Hide response attribute Show response attribute object
    • message string
  • 404

    Not Found

    Hide response attribute Show response attribute object
    • message string
  • 500

    Internal Server Error

    Hide response attribute Show response attribute object
    • message string
GET /addons/{addon-id}
curl \
 --request GET 'https://api.bitrise.io/v0.1/addons/{addon-id}'
Response examples (200)
{
  "data": {
    "banner_image": "string",
    "card_header_colors": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "description": "string",
    "developer_links": [
      {
        "title": "string",
        "url": "string"
      }
    ],
    "documentation_url": "string",
    "has_ui": true,
    "icon": "string",
    "id": "string",
    "is_beta": true,
    "plans": [
      {
        "features": [
          {
            "available": true,
            "description": "string",
            "quantity": "string"
          }
        ],
        "id": "string",
        "name": "string",
        "price": 42
      }
    ],
    "platforms": [
      "string"
    ],
    "preview_images": [
      "string"
    ],
    "setup_guide": {
      "instructions": [
        {
          "card_content": "string",
          "description": "string",
          "type": "string"
        }
      ],
      "notification": "string"
    },
    "subtitle": "string",
    "summary": "string",
    "title": "string"
  }
}
Response examples (400)
{
  "message": "string"
}
Response examples (401)
{
  "message": "string"
}
Response examples (404)
{
  "message": "string"
}
Response examples (500)
{
  "message": "string"
}