Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface paths

This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

Hierarchy

  • paths

Index

Properties

Properties

/pins

/pins: { get: { parameters: { query: { after?: string; before?: string; cid?: string[]; limit?: number; match?: "exact" | "iexact" | "partial" | "ipartial"; meta?: {}; name?: string; status?: ("failed" | "queued" | "pinning" | "pinned")[] } }; responses: { 200: { application/json: { count: number; results: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }[] } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown } }; post: { requestBody: { application/json: { cid: string; meta?: {}; name?: string; origins?: string[] } }; responses: { 202: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown } } }

Type declaration

  • get: { parameters: { query: { after?: string; before?: string; cid?: string[]; limit?: number; match?: "exact" | "iexact" | "partial" | "ipartial"; meta?: {}; name?: string; status?: ("failed" | "queued" | "pinning" | "pinned")[] } }; responses: { 200: { application/json: { count: number; results: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }[] } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown } }

    List all the pin objects, matching optional filters; when no filter is provided, only successful pins are returned

    • parameters: { query: { after?: string; before?: string; cid?: string[]; limit?: number; match?: "exact" | "iexact" | "partial" | "ipartial"; meta?: {}; name?: string; status?: ("failed" | "queued" | "pinning" | "pinned")[] } }
      • query: { after?: string; before?: string; cid?: string[]; limit?: number; match?: "exact" | "iexact" | "partial" | "ipartial"; meta?: {}; name?: string; status?: ("failed" | "queued" | "pinning" | "pinned")[] }
        • Optional after?: string
        • Optional before?: string
        • Optional cid?: string[]
        • Optional limit?: number
        • Optional match?: "exact" | "iexact" | "partial" | "ipartial"
        • Optional meta?: {}
          • [key: string]: any
        • Optional name?: string
        • Optional status?: ("failed" | "queued" | "pinning" | "pinned")[]
    • responses: { 200: { application/json: { count: number; results: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }[] } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown }
      • 200: { application/json: { count: number; results: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }[] } }

        Successful response (PinResults object)

        • application/json: { count: number; results: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }[] }
          • 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

      • 400: unknown
      • 401: unknown
      • 404: unknown
      • 409: unknown
      • 4XX: unknown
      • 5XX: unknown
  • post: { requestBody: { application/json: { cid: string; meta?: {}; name?: string; origins?: string[] } }; responses: { 202: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown } }

    Add a new pin object for the current access token

    • requestBody: { application/json: { cid: string; meta?: {}; name?: string; origins?: string[] } }
      • application/json: { 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[]
    • responses: { 202: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown }
      • 202: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }

        Successful response (PinStatus object)

        • application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }
          • 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"
      • 400: unknown
      • 401: unknown
      • 404: unknown
      • 409: unknown
      • 4XX: unknown
      • 5XX: unknown

/pins/{requestid}

/pins/{requestid}: { delete: { responses: { 202: unknown; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown } }; get: { responses: { 200: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown } }; parameters: { path: { requestid: string } }; post: { requestBody: { application/json: { cid: string; meta?: {}; name?: string; origins?: string[] } }; responses: { 202: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown } } }

Type declaration

  • delete: { responses: { 202: unknown; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown } }

    Remove a pin object

    • responses: { 202: unknown; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown }
      • 202: unknown

        Successful response (no body, pin removed)

      • 400: unknown
      • 401: unknown
      • 404: unknown
      • 409: unknown
      • 4XX: unknown
      • 5XX: unknown
  • get: { responses: { 200: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown } }

    Get a pin object and its status

    • responses: { 200: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown }
      • 200: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }

        Successful response (PinStatus object)

        • application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }
          • 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"
      • 400: unknown
      • 401: unknown
      • 404: unknown
      • 409: unknown
      • 4XX: unknown
      • 5XX: unknown
  • parameters: { path: { requestid: string } }
    • path: { requestid: string }
      • requestid: string
  • post: { requestBody: { application/json: { cid: string; meta?: {}; name?: string; origins?: string[] } }; responses: { 202: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown } }

    Replace an existing pin object (shortcut for executing remove and add operations in one step to avoid unnecessary garbage collection of blocks present in both recursive pins)

    • requestBody: { application/json: { cid: string; meta?: {}; name?: string; origins?: string[] } }
      • application/json: { 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[]
    • responses: { 202: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }; 400: unknown; 401: unknown; 404: unknown; 409: unknown; 4XX: unknown; 5XX: unknown }
      • 202: { application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" } }

        Successful response (PinStatus object)

        • application/json: { created: string; delegates: string[]; info?: {}; pin: { cid: string; meta?: {}; name?: string; origins?: string[] }; requestid: string; status: "failed" | "queued" | "pinning" | "pinned" }
          • 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"
      • 400: unknown
      • 401: unknown
      • 404: unknown
      • 409: unknown
      • 4XX: unknown
      • 5XX: unknown