habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
api-reference-docs
elasticsearch-js/docs/reference/api/License.md
Josh Mock b140fcda7f Another round of tweaks
2025-05-28 10:02:30 -05:00

8.7 KiB
Raw Permalink Blame History

License [class-License]

Constructor

new License(transport: [Transport](./Transport.md));

Properties [class-properties-License]

Name Type Description
acceptedParams Record<string, { path: string[]; body: string[]; query: string[]; }>  
transport Transport  

Methods [class-methods-License]

Name Signature Description
delete delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseDeleteResponse](./LicenseDeleteResponse.md)>; Delete the license. When the license expires, your subscription level reverts to Basic. If the operator privileges feature is enabled, only operator users can use this API.
delete delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseDeleteResponse](./LicenseDeleteResponse.md), unknown>>;  
delete delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseDeleteResponse](./LicenseDeleteResponse.md)>;  
get get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetResponse](./LicenseGetResponse.md)>; Get license information. Get information about your Elastic license including its type, its status, when it was issued, and when it expires. > info > If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. > If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.
get get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetResponse](./LicenseGetResponse.md), unknown>>;  
get get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetResponse](./LicenseGetResponse.md)>;  
getBasicStatus getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md)>; Get the basic license status.
getBasicStatus getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md), unknown>>;  
getBasicStatus getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md)>;  
getTrialStatus getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md)>; Get the trial status.
getTrialStatus getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md), unknown>>;  
getTrialStatus getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md)>;  
post post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostResponse](./LicensePostResponse.md)>; Update the license. You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. If the operator privileges feature is enabled, only operator users can use this API.
post post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostResponse](./LicensePostResponse.md), unknown>>;  
post post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostResponse](./LicensePostResponse.md)>;  
postStartBasic postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md)>; Start a basic license. Start an indefinite basic license, which gives access to all the basic features. NOTE: In order to start a basic license, you must not currently have a basic license. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. To check the status of your basic license, use the get basic license API.
postStartBasic postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md), unknown>>;  
postStartBasic postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md)>;  
postStartTrial postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md)>; Start a trial. Start a 30-day trial, which gives access to all subscription features. NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. To check the status of your trial, use the get trial status API.
postStartTrial postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md), unknown>>;  
postStartTrial postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md)>;