Index

The Index model is a fundamental component of the Index Network, designed to facilitate context management and enable semantic interoperability within your system. It serves as a structured way to organize and store data related to specific contexts. Below is a description of the Index schema and its primary functions:

To create an index, you should first mint a LIT Programmable Key Pair (PKP).

Mint a new PKP on Testnet

Index Schema

The Index schema consists of several key properties:

Property	Type	Description
title	String	The title or name associated with the Index, providing context identification.
signerFunction	CID	IPFS CID that stores the Lit Action function
signerPublicKey	String	Public key of the minted LIT Programmable Key Pair
updatedAt	DateTime	The timestamp when the Index was last updated, ensuring data accuracy.
deletedAt	DateTime	The timestamp when the Index was deleted (if applicable).
controllerDID	DID (Identifier)	The Decentralized Identifier (DID) of the controller for access control.

Endpoints

This section provides details about the available API endpoints.

Create index

POSThttps://dev.index.network/api/indexes

Authorization

didSessionAuth

Body

application/json

titlestring

signerPublicKeystring

signerFunctionstring

Response

201

Index created

Request

JavaScriptCurlPython

const response = await fetch('https://dev.index.network/api/indexes', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer DID_SESSION_SERIALIZED",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get index by ID

GEThttps://dev.index.network/api/indexes/{id}

Path parameters

id*string

Index ID

Response

200

Successful operation

Request

JavaScriptCurlPython

const response = await fetch('https://dev.index.network/api/indexes/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Update index

PATCHhttps://dev.index.network/api/indexes/{id}

Authorization

didSessionAuth

Path parameters

id*string

Index ID

Body

application/json

titlestring

signerFunctionstring

Response

200

Index updated

Request

JavaScriptCurlPython

const response = await fetch('https://dev.index.network/api/indexes/{id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer DID_SESSION_SERIALIZED",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete index

DELETEhttps://dev.index.network/api/indexes/{id}

Authorization

didSessionAuth

Path parameters

id*string

Index ID

Response

200

Index deleted

Request

JavaScriptCurlPython

const response = await fetch('https://dev.index.network/api/indexes/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer DID_SESSION_SERIALIZED"
    },
});
const data = await response.json();