Create an index

Create an index.

POST /projects/{projectId}/indexes

cURL

cURL

curl --request POST \
  --url https://{baseUrl}/{version}/projects/{projectId}/indexes \
  --header 'content-type: <content-type>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "indexName": "<string>",
  "mappings": {},
  "indexClass": "STANDARD",
  "sourceProjectId": "<string>",
  "sourceIndexName": "<string>",
  "sourceProjectApiKey": "<string>"
}
'

202

{
  "projectId": "<string>",
  "indexName": "<string>",
  "mappings": {},
  "numDocs": 123,
  "cloneSourceInfo": {
    "sourceProjectId": "<string>",
    "sourceIndexName": "<string>",
    "sourceIndexVersionId": "<string>"
  },
  "indexStatus": "CREATING",
  "indexClass": "STANDARD"
}

Headers

content-type · string · default: application/json · required

x-api-key · string · required

Project API Key.

Path Parameters

projectId · string · required

Project ID.

Body

application/json

indexName · string · required

Index name must be unique within a project and the supported maximum length is 52.

mappings · object

Show child attributes

indexClass · enum<string> · default: STANDARD

Index class.

Available options: STANDARD, INFREQUENT_ACCESS

sourceProjectId · string

sourceIndexName · string

sourceProjectApiKey · string

Response

202 - application/json

Created index

projectId · string

Project ID.

indexName · string

Index name.

mappings · object

Show child attributes

numDocs · integer

Total number of documents.

cloneSourceInfo · object

Clone source information.

Show child attributes

indexStatus · enum<string>

Status

Available options: CREATING, ACTIVE, DELETING

indexClass · enum<string> · default: STANDARD

Index class.

Available options: STANDARD, INFREQUENT_ACCESS