Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface components

Hierarchy

  • components

Index

Properties

Properties

parameters

parameters: { after: string; before: string; cid: string[]; limit: number; match: "exact" | "iexact" | "partial" | "ipartial"; meta: {}; name: string; status: ("failed" | "queued" | "pinning" | "pinned")[] }

Type declaration

  • after: string

    Return results created (queued) after provided timestamp

  • before: string

    Return results created (queued) before provided timestamp

  • cid: string[]

    Return pin objects responsible for pinning the specified CID(s); be aware that using longer hash functions introduces further constraints on the number of CIDs that will fit under the limit of 2000 characters per URL in browser contexts

  • limit: number

    Max records to return

  • match: "exact" | "iexact" | "partial" | "ipartial"

    Customize the text matching strategy applied when name filter is present

  • meta: {}

    Return pin objects that match specified metadata

    • [key: string]: any
  • name: string

    Return pin objects with specified name (by default a case-sensitive, exact match)

  • status: ("failed" | "queued" | "pinning" | "pinned")[]

    Return pin objects for pins with the specified status

responses

responses: { BadRequest: {}; CustomServiceError: {}; InsufficientFunds: {}; InternalServerError: {}; NotFound: {}; Unauthorized: {} }

Type declaration

  • BadRequest: {}

    Error response (Bad request)

    • [key: string]: any
  • CustomServiceError: {}

    Error response (Custom service error)

    • [key: string]: any
  • InsufficientFunds: {}

    Error response (Insufficient funds)

    • [key: string]: any
  • InternalServerError: {}

    Error response (Unexpected internal server error)

    • [key: string]: any
  • NotFound: {}

    Error response (The specified resource was not found)

    • [key: string]: any
  • Unauthorized: {}

    Error response (Unauthorized; access token is missing or invalid)

    • [key: string]: any

schemas

schemas: { Delegates: string[]; Failure: { error: { details?: string; reason: string } }; Origins: string[]; Pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; PinMeta: {}; PinResults: { count: number; results: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }[] }; PinStatus: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }; Status: "failed" | "queued" | "pinning" | "pinned"; StatusInfo: {}; TextMatchingStrategy: "exact" | "iexact" | "partial" | "ipartial" }

Type declaration

  • Delegates: string[]

    List of multiaddrs designated by pinning service for transferring any new data from external peers

  • Failure: { error: { details?: string; reason: string } }

    Response for a failed request

    • error: { details?: string; reason: string }
      • Optional details?: string

        Optional, longer description of the error; may include UUID of transaction for support, links to documentation etc

      • reason: string

        Mandatory string identifying the type of error

  • Origins: string[]

    Optional list of multiaddrs known to provide the data

  • Pin: { cid: string; meta?: {}; name?: string; origins?: string[] }

    Pin object

    • cid: string

      Content Identifier (CID) to be pinned recursively

    • Optional meta?: {}
      • [key: string]: string
    • Optional name?: string

      Optional name for pinned data; can be used for lookups later

    • Optional origins?: string[]
  • PinMeta: {}

    Optional metadata for pin object

    • [key: string]: string
  • PinResults: { count: number; results: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }[] }

    Response used for listing pin objects matching request

    • count: number

      The total number of pin objects that exist for passed query filters

    • results: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }[]

      An array of PinStatus results

  • PinStatus: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }

    Pin object with status

    • created: string

      Immutable timestamp indicating when a pin request entered a pinning service; can be used for filtering results and pagination

    • delegates: string[]
    • Optional info?: {}
      • [key: string]: string
    • pin: { cid: string; meta?: {}; name?: string; origins?: string[] }
      • cid: string

        Content Identifier (CID) to be pinned recursively

      • Optional meta?: {}
        • [key: string]: string
      • Optional name?: string

        Optional name for pinned data; can be used for lookups later

      • Optional origins?: string[]
    • requestid: string

      Globally unique identifier of the pin request; can be used to check the status of ongoing pinning, or pin removal

    • status: "failed" | "queued" | "pinning" | "pinned"
  • Status: "failed" | "queued" | "pinning" | "pinned"

    Status a pin object can have at a pinning service

  • StatusInfo: {}

    Optional info for PinStatus response

    • [key: string]: string
  • TextMatchingStrategy: "exact" | "iexact" | "partial" | "ipartial"

    Alternative text matching strategy