Own MIMIC? Customize your docs with AI search, analytics, and more.

POST

Adds a new ipalias for the agent.

http://gambitcomm.local/mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface}

port defaults to 161 if not specified. mask defaults to the class-based network mask for the address. interface defaults to the default network interface. If port is set to 0, the system will automatically select a port number. This is useful for client-mode protocols, such as TFTP or TOD. Upon start of an IP alias with a 0 (auto-assigned) port number, its port will change to contain the value of the selected system port.

Access Token Required: API Key

Path Parameters

agentNumintegerrequired

Agent to add the IP alias

IPstringrequired

IP address , IPv4 or IPv6

portintegerrequired

SNMP port , 0 or empty for default

maskstringrequired

Netmask, empty for default

interfacestringrequired

Interface. Empty for default

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://gambitcomm.local/mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Adds a new ipalias for the agent.

http://gambitcomm.local/mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface}

port defaults to 161 if not specified. mask defaults to the class-based network mask for the address. interface defaults to the default network interface. If port is set to 0, the system will automatically select a port number. This is useful for client-mode protocols, such as TFTP or TOD. Upon start of an IP alias with a 0 (auto-assigned) port number, its port will change to contain the value of the selected system port.

Access Token Required: API Key

Path Parameters

agentNumintegerrequired

Agent to add the IP alias

IPstringrequired

IP address , IPv4 or IPv6

portintegerrequired

SNMP port , 0 or empty for default

maskstringrequired

Netmask, empty for default

interfacestringrequired

Interface. Empty for default

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://gambitcomm.local/mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Adds a new ipalias for the agent.

http://gambitcomm.local/mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface}

port defaults to 161 if not specified. mask defaults to the class-based network mask for the address. interface defaults to the default network interface. If port is set to 0, the system will automatically select a port number. This is useful for client-mode protocols, such as TFTP or TOD. Upon start of an IP alias with a 0 (auto-assigned) port number, its port will change to contain the value of the selected system port.

Access Token Required: API Key

Path Parameters

agentNumintegerrequired

Agent to add the IP alias

IPstringrequired

IP address , IPv4 or IPv6

portintegerrequired

SNMP port , 0 or empty for default

maskstringrequired

Netmask, empty for default

interfacestringrequired

Interface. Empty for default

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://gambitcomm.local/mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Adds a new ipalias for the agent.

http://gambitcomm.local/mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface}

port defaults to 161 if not specified. mask defaults to the class-based network mask for the address. interface defaults to the default network interface. If port is set to 0, the system will automatically select a port number. This is useful for client-mode protocols, such as TFTP or TOD. Upon start of an IP alias with a 0 (auto-assigned) port number, its port will change to contain the value of the selected system port.

Access Token Required: API Key

Path Parameters

agentNumintegerrequired

Agent to add the IP alias

IPstringrequired

IP address , IPv4 or IPv6

portintegerrequired

SNMP port , 0 or empty for default

maskstringrequired

Netmask, empty for default

interfacestringrequired

Interface. Empty for default

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://gambitcomm.local/mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}