EVevolution-foundation
Instance Controller

Fetch Instances

Changed on

Returns the instance with the name informed in the parameter, or all the instances if empty.

get/instance/fetchInstances

Request

  • Base URL
    https://evolution-example
  • URL
    https://evolution-example/instance/fetchInstances
  • Auth
    API key in header apikey

Query parameters

instanceNamestring

Name of the instance to be fetched

instanceIdstring

ID of the instance to be fetched

Response

Ok

statusinteger

The HTTP status of the response

errorstring

The error message indicating the type of error

Changes

  • v20184b7a57041Revision changes
    • info

      added the new optional query request parameter instanceId

  • v2c153448703e5Revision changes
    • info

      api operation id fetchInstances was added

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security apikeyAuth was removed from the API

    • info

      api tag Instance Controller added

    • info

      api tag Instance removed

    • info

      added the new optional query request parameter instanceName