Skip to main content

autessa.ghost

9 methods in the ghost namespace.

autessa.ghost.connectors.allREAD

autessa.ghost.connectors.all()

List every Ghost connector you can access in your company.

Returns all Ghost connectors in your current company that you have at least READ access to, newest-relevant first. Use a connector's connectorId with the other ghost.connectors.* methods. Credentials are never included in the returned DTOs.

Request fields

No fields.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connectors
    Type
    GhostConnectorDto[]
    Description

autessa.ghost.connectors.createMUTATE

autessa.ghost.connectors.create({ connectorName, adminApiKey, apiUrl })

Create a Ghost connector from an Admin API key and site URL.

Stores a Ghost Admin API key and site API URL as a new connector for your company. HIGH risk: it persists a credential that grants full admin access to the Ghost site's content and members. After creating, verify it with connectors.testConnection. The key is stored encrypted and never returned.

Request fields

  • Name
    connectorName
    Type
    string
    Description
  • Name
    adminApiKey
    Type
    string
    Description
  • Name
    apiUrl
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connector
    Type
    GhostConnectorDto
    Description
  • Name
    message
    Type
    string
    Description

autessa.ghost.connectors.deleteMUTATE

autessa.ghost.connectors.delete({ connectorId })

Permanently delete a Ghost connector and its stored credential.

Removes the Ghost connector for connectorId, revoking every tool and script that relied on it. The stored credential is destroyed and cannot be recovered — reconnecting requires the full auth flow again. Requires WRITE (owner-level) access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    message
    Type
    string
    Description

autessa.ghost.connectors.getREAD

autessa.ghost.connectors.get({ connectorId })

Fetch one Ghost connector by id.

Returns the full Ghost connector for connectorId, including its sharing/active state and the linked account metadata — but never the stored credential. Fails if you lack READ access to the connector.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connector
    Type
    GhostConnectorDto
    Description

autessa.ghost.connectors.getSharingDetailsREAD

autessa.ghost.connectors.getSharingDetails({ connectorId })

Read the current sharing configuration of a Ghost connector.

Returns how the Ghost connector is shared: the overall sharingLevel, the companyPermissionLevel granted for COMPANY sharing, the explicit sharedWith members, and your own userAccessLevel. Use before share to see the current state.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    sharingLevel
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    companyPermissionLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    sharedWith
    Type
    UserShareWrapper[]
    Description
  • Name
    userAccessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description

autessa.ghost.connectors.shareMUTATE

autessa.ghost.connectors.share({ connectorId, level, accessLevel, usersToAdd, usersToRemove })

Change who in your company can use a Ghost connector.

Sets the sharing scope of the Ghost connector. level=PRIVATE keeps it to the owner; level=COMPANY grants everyone in the company the given accessLevel; level=SPECIFIC_MEMBER shares with named users — add them in usersToAdd and revoke via usersToRemove (each as a UserShareWrapper). accessLevel applies to COMPANY sharing. Sharing lets other members' tools and scripts use the connector; the credential itself is never exposed. Requires WRITE access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.
  • Name
    level
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    accessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    usersToAdd
    Type
    UserShareWrapper[]
    Description
  • Name
    usersToRemove
    Type
    UserShareWrapper[]
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    level
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    accessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    usersWithAccess
    Type
    UserShareWrapper[]
    Description

autessa.ghost.connectors.testConnectionMUTATE

autessa.ghost.connectors.testConnection({ connectorId })

Verify a stored Ghost connector still authenticates against its site.

Re-checks an existing Ghost connector's stored Admin API key against the Ghost site and returns connectionSuccessful. Takes the connectorId (not a raw key) — use it to confirm a connector still works after key rotation or a site change. Does not persist anything.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connectionSuccessful
    Type
    boolean
    Description
  • Name
    message
    Type
    string
    Description

autessa.ghost.connectors.updateMUTATE

autessa.ghost.connectors.update({ connectorId, connectorName, isActive })

Rename a Ghost connector or toggle whether it is active.

Applies a sparse patch to the Ghost connector for connectorId: send connectorName to rename it, isActive to enable/disable it. This is a partial update — omit a field to leave it unchanged; sending null or an empty name is ignored. Does not touch the stored credential or sharing. Requires WRITE access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.
  • Name
    connectorName
    Type
    string
    Description
  • Name
    isActive
    Type
    boolean
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    message
    Type
    string
    Description
  • Name
    connector
    Type
    GhostConnectorDto
    Description