This is a standard ApplicationEditor method which allows you to create and modify objects by applying transactions. For documentation on these endpoints, see Conduit API: Using Edit Endpoints.
Conduit almanac.interface.edit
almanac.interface.edit
almanac.interface.edit
API Method: almanac.interface.edit
API Method: almanac.interface.edit
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Returns
- map<string, wild>
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Description
Transaction Types
Transaction Types
This endpoint supports these types of transactions. See below for detailed information about each transaction type.
| Key | Description |
|---|---|
| device | Set the device. |
| network | Network for the interface. |
| address | Address of the service. |
| port | Port of the service. |
| mfa | Sign this transaction group with MFA. |
Transaction Type: device
Transaction Type: device
Set the device.
| Key | Type | Description |
|---|---|---|
| type | const | device |
| value | string | Device PHID. |
Transaction Type: network
Transaction Type: network
Network for the interface.
| Key | Type | Description |
|---|---|---|
| type | const | network |
| value | string |
Transaction Type: address
Transaction Type: address
Address of the service.
| Key | Type | Description |
|---|---|---|
| type | const | address |
| value | string |
Transaction Type: port
Transaction Type: port
Port of the service.
| Key | Type | Description |
|---|---|---|
| type | const | port |
| value | int |
Transaction Type: mfa
Transaction Type: mfa
Sign this transaction group with MFA.
| Key | Type | Description |
|---|---|---|
| type | const | mfa |
| value | bool |
Call Method
Call Method
Examples
Examples
- Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
- If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://isabelle-dev.sketis.net/ --conduit-token <conduit-token> -- almanac.interface.edit
$ curl https://isabelle-dev.sketis.net/api/almanac.interface.edit \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/arcanist/support/init/init-script.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://isabelle-dev.sketis.net/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('almanac.interface.edit', $api_parameters);
print_r($result);