Create list data streams

View as Markdown
POST /api/lists/index
Api key auth Basic auth

Spaces method and path for this operation:

post /s/{space_id}/api/lists/index

Refer to Spaces for more information.

Create .lists and .items data streams in the relevant space.

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • acknowledged boolean Required
  • 400 application/json

    Invalid input data response

    One of:
    Security_Lists_API_PlatformErrorResponse object Security_Lists_API_SiemErrorResponse object
  • 401 application/json

    Unsuccessful authentication response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode integer Required
  • 403 application/json

    Not enough privileges response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode integer Required
  • 409 application/json

    List data stream exists response

    Hide response attributes Show response attributes object
    • message string Required
    • status_code integer Required
  • 500 application/json

    Internal server error response

    Hide response attributes Show response attributes object
    • message string Required
    • status_code integer Required
POST /api/lists/index 
curl \ --request POST 'https://localhost:5601/api/lists/index' \ --header "Authorization: $API_KEY"
Response examples (401) 
{ "error": "Unauthorized", "message": "[security_exception\\n\\tRoot causes:\\n\\t\\tsecurity_exception: unable to authenticate user [elastic] for REST request [/_security/_authenticate]]: unable to authenticate user [elastic] for REST request [/_security/_authenticate]\n", "statusCode": 401 }
Response examples (409) 
{ "message": "data stream: \\\".lists-default\\\" and \\\".items-default\\\" already exists", "status_code": 409 }
Response examples (500) 
{ "message": "Internal Server Error", "status_code": 500 }