API Stability Long-Term

The deleteSearchDomainById() GraphQL mutation may be used to delete a repository or view.

Syntax

Below is the syntax for the deleteSearchDomainById() mutation field:

graphql
deleteSearchDomainById(
      input: DeleteSearchDomainByIdInput!
   ): boolean!

Below is an example of how this mutation field might be used:

Show:
graphql
mutation {
  deleteSearchDomainById( input: {
       id: "JekdMHiFPEWnbXTtg6IS5lKggn3f",
       deleteMessage: "Sorry: Had to be deleted."
  } )
}
Example Responses
Show:
json
{
  "data": {
    "deleteSearchDomainById": true
  }
}

Given Datatypes

For DeleteSearchDomainByIdInput, there are two parameters. Below are descriptions of them:

Table: DeleteSearchDomainByIdInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 18, 2024
deleteMessagestring   Optional message to why the search domain was deleted. Will be added to the audit log.
idstringyes  The unique identifier of the search domain.