Endpoints

Overview of available endpoints.

Information Requests

Information Requests are used to obtain basic information about the API, being the current version of Sagittarius A*, and obtaining the API Spec. These requests directly obtain information displayed in their output from the API's Specification.

  /version:
    get:
      summary: Get the Sagittarius A* version number.
  /spec:
    get:
      summary: Outputs this spec.yaml in JSON format.

Resolution Requests

Resolution Requests are used for Domain Resolution as described in Resolution Overview. These requests are used to resolve the content records associated with an Ethereum Name Service (ENS) domain. There requests also support retrieval of domain records and data without initiating a resolution request, and the retrieval of domain content over a provided IPFS gateway URL.

  /domain/resolve/{domain}:
    get:
      summary: Resolve an ENS Domain to content or wallet address. Initiates an IPNS resolution request if the content is IPNS.
      parameters:
        - in: path
          name: domain
          required: true
          description: An ENS domain name.
          schema:
            type: string
  /domain/ipfs/{domain}/{gatewayURL}:
    get:
      summary: Submit an ENS Domain for IPFS content retrieval over a passed Gateway URL.
      parameters:
        - in: path
          name: domain
          required: true
          description: An ENS domain name.
          schema:
            type: string
        - in: path
          name: gatewayURL
          required: true
          description: An approved IPFS Gateway URL.
          schema:
            type: string
  /domain/records/{domain}:
    get:
      summary: Retrieve an ENS Domain's content records without initiating a resolution request.
      parameters:
        - in: path
          name: domain
          required: true
          description: An ENS domain name.
          schema:
            type: string
  /domain/data/{domain}:
    get:
      summary: Fetch an ENS Domain's domain data.
      parameters:
        - in: path
          name: domain
          required: true
          description: An ENS domain name.
          schema:
            type: string

IPFS Requests

Requests for IPFS Requests are used to manage the pinning of IPFS Content Identifiers (CIDs) to the Sagittarius A* IPFS Cluster. CID pinning includes a request ID system based roughly on the requestid from the IPFS Pinning Service API. These requests also include resolution of names from the InterPlanetary Name System (IPNS) into IPFS CIDs.

  /ipfs/pin/add/{cid}:
    post:
      summary: Pin an IPFS CID.
      parameters:
        - in: path
          name: cid
          required: true
          description: An IPFS Content Identifier (CID).
          schema:
            type: string
  /ipfs/pin/rm/{cid}:
    delete:
      summary: Unpin an IPFS CID.
      parameters:
        - in: path
          name: cid
          required: true
          description: An IPFS Content Identifier (CID).
          schema:
            type: string
  /ipfs/pin/status/{cid}:
    get:
      summary: Obtain the pin status of an IPFS CID.
      parameters:
        - in: path
          name: cid
          required: true
          description: An IPFS Content Identifier (CID).
          schema:
            type: string
  /ipfs/pin/ls:
    get:
      summary: List all CIDs pinned by the requestor.
  /ipns/resolve/{name}:
    post:
      summary: Submit an IPNS name for resolution into an IPFS CID. Returns a taskID, and cached CID if available.
      parameters:
        - in: path
          name: name
          required: true
          description: An IPNS name (a mutable pointer to an IPFS CID).
          schema:
            type: string
  /ipns/result/{taskId}:
    get:
      summary: Request the status of an IPNS name resolution.
      parameters:
        - in: path
          name: taskId
          required: true
          description: A unique identifier for the resolution process of an IPNS name.
          schema:
            type: string