Make changes using GraphQL

GraphQL Mutations are available to create, update or delete any objects in the database. In a REST API they are the equivalent to the methods POST, PUT, or DELETE.

info

To execute any mutation you'll need to define a HTTP header in the GraphQL Explorer:

X-INFRAHUB-KEY: 06438eb2-8019-4776-878c-0941b1f1d1ec

# Endpoint : http://localhost:8000/graphql/main
mutation {
  OrganizationTenantCreate(
    data: {
      name: { value: "Hooli" },
      description: { value: "Transforming the world as we know it."}
    }
  ) {
    ok
    object {
      id
    }
  }
}

Add a new interface and a new IP address in the Graph

Add a new interface Ethernet0 to the device ord1-edge1.

# Endpoint : http://127.0.0.1:8000/graphql/cr1234
mutation {
  InfraInterfaceL3Create(
    data: {
      name: { value: "Ethernet0" }
      enabled: { value: true }
      description: { value: "new interface in branch" }
      device: { hfid: ["ord1-edge1"] }
      status: { value: "active" }
      speed: { value: 10000 }
      role: { value: "spare" }
    }
  ) {
    ok
    object {
      id
      hfid
      name {
        value
      }
      description {
        value
      }
    }
  }
}

Add a new IP address connected to the new interface.

# Endpoint : http://127.0.0.1:8000/graphql/cr1234
mutation {
  IpamIPAddressCreate(
    data: {
      interface: { hfid: ["ord1-edge1", "Ethernet0"]},
      address: { value: "192.168.0.2/24" }
    }
  ) {
    ok
    object {
      id
      address {
        value
      }
    }
  }
}