> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beyondwords.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Test Ghost integration

> Test the Ghost API URL and Admin API key before saving integration settings.

Test the Ghost API URL and Admin API key before saving integration settings.


## OpenAPI

````yaml post /projects/{project_id}/integrations/ghost/test
openapi: 3.0.1
info:
  title: BeyondWords REST API
  description: |-
    This is the documentation for the BeyondWords REST API.
              You can use this API to use BeyondWords programmatically.
              You can get your API Key and Project ID for each project in the Project settings tab in the BeyondWords
              <a href="https://dash.beyondwords.io/dashboard">dashboard</a>.
  version: 1.0.0
servers:
  - url: https://api.beyondwords.io/v1
security: []
paths:
  /projects/{project_id}/integrations/ghost/test:
    parameters:
      - name: project_id
        in: path
        description: The numeric ID of your project
        required: true
        schema:
          type: string
    post:
      tags:
        - Ghost
      summary: Test Ghost integration
      description: >-
        Test the Ghost API URL and Admin API key before saving integration
        settings.
      operationId: ghost#test
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/requestBodyGhostIntegrationTest'
      responses:
        '200':
          description: successful
          content:
            application/json:
              examples:
                example:
                  $ref: '#/components/examples/ghostIntegrationExample'
              schema:
                $ref: '#/components/schemas/ghostIntegrationTestResponse'
      security:
        - apiKey: []
components:
  schemas:
    requestBodyGhostIntegrationTest:
      type: object
      properties:
        admin_api_key:
          type: string
        api_url:
          type: string
    ghostIntegrationTestResponse:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether or not ghost should be enabled. The default is `disabled`.
        admin_api_key:
          type: string
          nullable: true
          description: Admin API key for Ghost integration
        api_url:
          type: string
          nullable: true
          description: Ghost API url
        created:
          type: string
          format: date-time
          description: Time at which the object was created (ISO 8601)
        updated:
          type: string
          format: date-time
          description: Time at which the object was updated (ISO 8601)
  examples:
    ghostIntegrationExample:
      summary: A sample Ghost integration
      value:
        enabled: false
        admin_api_key: 4a7ff4d73a1e36b9549449489c7cf85b
        api_url: https://localhost.ghost.io
        created: 2019-12-09 22:18:26 UTC
        updated: 2020-01-23 08:55:38 UTC
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-Api-Key
      in: header

````