1.) General information

1.1 HTTP Request methods

1.2 Request structure

GET /api/myAPP/sections/ HTTP/1.1
Content-Type: application/json
token: UJMcRNGjxH5UvHGeRy!vzgtL
Host: api.phpipam.net

1.3 Encrypted requests

urlencode(base64_encode(mcrypt_encrypt(MCRYPT_RIJNDAEL_256, {app_key}, json_encode($request_params), MCRYPT_MODE_ECB)))

• json_encode request parameters ($_GET)
• encrypt json_encoded parameters with rijndael_256 using app_key provided in phpipam gui for app
• base64 encode encrypted parameters to ensure html chars are encoded
• send GET request with app_id and created enc_request parameters

1.4 Response handling

• 2xx success
• 4xx client errors
• 5xx server errors

• success (true, false)
• code (http result code)
• message (in case of failures)
• data (in case data is present)

HTTP/1.1 200 OK
Date: Tue, 16 Jun 2015 06:19:33 GMT
Server: Apache/2.4.12 (FreeBSD) OpenSSL/1.0.1l-freebsd
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 261
Connection: close
Content-Type: application/json
token: UJMcRNGjxH5UvHGeRy!vzgtL
{
    “code“: 200,
    “success“: true,
    “data“: {
    “id”: “92”,
    “name”: “api_post_create”,
    “description”: “lalala 12”,
    …
    }
}

HTTP/1.1 400 Bad Request
Date: Tue, 16 Jun 2015 06:38:41 GMT
Server: Apache/2.4.12 (FreeBSD) OpenSSL/1.0.1l-freebsd
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 59
Connection: close
Content-Type: application/json
{
    “code“: 400,
    “success“: false,
    “message“: “invalid controller”
}

HTTP/1.1 201 Created
Date: Mon, 15 Jun 2015 14:01:36 GMT
Server: Apache/2.4.12 (FreeBSD) OpenSSL/1.0.1l-freebsd
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-cache
Pragma: no-cache
Location: /api/myAPP/sections/92/
Content-Length: 65
Connection: close
Content-Type: application/json
{
    “code”: 201,
    “success”: true,
    “id”:92,
    “data”: “Section created successfully”
}

1.5 Output format

• JSON (default)
• XML

Content-Type: application/xml

1.6 Global API parameters

{
"code": 200,
"success": true,
"data": {
    "id": "1472",
    "showName": "0",
    ...
    "links": [
        {
        "rel": "self",
        "href": "/api/myAPP/subnets/1472/",
        "methods": [
            "GET",
            "POST",
            "DELETE",
            "PATCH"
            ]
        },
        {
        "rel": "usage",
        "href": "/api/myAPP/subnets/1472/usage/",
        "methods": [
            "GET"
            ]
        }
        ...
    }

2.) Authentication and permissions

2.1 Dynamic authentication

• Authentication is required for NONE and SSL security
• SSL security is highly recommended

Available methods for authentication (user) controller:

POST /api/myAPP/user/ HTTP/1.1
Authorization: Basic YWgta146c3A0bm1raWE=
Host: api.phpipam.net

HTTP/1.1 200 OK
Date: Thu, 09 Jul 2015 06:05:28 GMT
Server: Apache/2.4.12 (FreeBSD) OpenSSL/1.0.1l-freebsd
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 103
Content-Type: application/json

{“code”:200,”success”:true,”data”:{“token”:”Z1q=j2bdwx56NR14KFcTi7P$”,”expires”:”2015-07-09 20:05:28″}}

GET /api/myAPP/sections/ HTTP/1.1
token: Z1q=j2bdwx56NR14KFcTi7P$
Host: api.phpipam.net

2.2 Static authentication

2.2 Authorisation (permissions)

• Disabled
• Read
• Read / Write
• Read / Write / Admin

curl -X OPTIONS -H "token: Z1q=j2bdwx56NR14KFcTi7P$" "http://api.phpipam.net/api/myAPP/"

{
    "code": 200,
    "success": true,
    "data": {
        "permissions": "Read / Write",
        "controllers": [
        ...
        ]
    }
}

3.) Controllers

OPTIONS /api/myAPP/ HTTP/1.1
Host: api.phpipam.net
token: UJMcRNGjxH5UvHGeRy!vzgtL

HTTP/1.1 200 OK
Server: Apache/2.4.12 (FreeBSD) OpenSSL/1.0.1l-freebsd
Content-Length: 416
Connection: close
Content-Type: application/json
{
    “code”: 200,
    “success”: true,
    “data”: [
    {
        “href”: “/api/myAPP/sections/”,
        “rel”: “Sections”
    },
    {
        “href”: “/api/myAPP/subnets/”,
        “rel”: “Subnets”
    },
    …
    ]
}

3.1 Sections controller

3.2 Subnets controller

3.3 Folders controller

3.4 Addresses controller

3.5 VLAN controller

3.6 VLAN Domains controller (L2 domains)

3.7 VRF controller

3.8 Devices controller 1.3

3.9 Tools controller

• tags
• devices
• device_types
• vlans
• vrfs
• nameservers
• scanagents
• locations 1.3
• nat 1.3
• racks 1.3

3.10 Prefixes controller 1.3

• $custom_field_name = “customer_type”;
• $custom_field_orderby = “subnet”;
• $custom_field_order_direction = “asc”;

• $custom_field_name_addr = “customer_type”;
• $custom_field_orderby_addr= “subnet”;
• $custom_field_order_direction_addr = “asc”;

GET/POST /api/{app_id}/prefixes/{customer_type}/{address_type}/{mask}/
address_type: v4/v6
mask: requested mask

Array
(
    [code] => 201
    [success] => 1
    [id] => 3241
    [message] => Subnet created
    [data] => 10.10.0.1/32
    [time] => 0.053
)